diff --git a/pipeline/outputs/logdna.md b/pipeline/outputs/logdna.md index e948f23e7..8304bf131 100644 --- a/pipeline/outputs/logdna.md +++ b/pipeline/outputs/logdna.md @@ -1,112 +1,41 @@ # LogDNA -[LogDNA](https://logdna.com/) is an intuitive cloud based log management system that provides you an easy interface to query your logs once they are stored. - -The Fluent Bit `logdna` output plugin allows you to send your log or events to a [LogDNA](https://logdna.com/) compliant service like: - -* [LogDNA](https://logdna.com/) -* [IBM Log Analysis](https://www.ibm.com/cloud/log-analysis) - -Before to get started with the plugin configuration, make sure to obtain the proper account to get access to the service. You can start with a free trial in the following link: - -* [LogDNA Sign Up ](https://logdna.com/sign-up/) - -## Configuration Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyDescriptionDefault
logdna_hostLogDNA API host addresslogs.logdna.com
logdna_portLogDNA TCP Port443
logdna_endpointLogDNA ingestion endpoint/logs/ingest
api_keyAPI key to get access to the service. This property is mandatory.
hostname -

Name of the local machine or device where Fluent Bit is running. -
-

-

When this value is not set, Fluent Bit lookup the hostname and auto populate - the value. If it cannot be found, an unknown value will be set - instead.

-
macMac address. This value is optional.
ipIP address of the local hostname. This value is optional.
tagsA list of comma separated strings to group records in LogDNA and simplify - the query with filters.
fileOptional name of a file being monitored. Note that this value is only - set if the record do not contain a reference to it.
appName of the application. This value is auto discovered on each record, - if not found, the default value is used.Fluent Bit
workersThe number of workers to perform flush operations for this output.`0`
- -## Auto Enrichment & Data Discovery - -One of the features of Fluent Bit + LogDNA integration is the ability to auto enrich each record with further context. - -When the plugin process each record \(or log\), it tries to lookup for specific key names that might contain specific context for the record in question, the following table describe the keys and the discovery logic: +The _LogDNA_ output plugin sends logs and events to a LogDNA-compliant service. + +## Configuration parameters + +This plugin uses the following configuration parameters: + +| Key | Description | Default | +| --- | ----------- | ------- | +| `logdna_host` | The LogDNA API host address. | `logs.logdna.com` | +| `logdna_port` | The LogDNA TCP Port. | `443` | +| `logdna_endpoint` | The LogDNA ingestion endpoint. | `/logs/ingest` | +| `api_key` | Required. The API key to get access to the service. | _none_ | +| `hostname` | Name of the local machine or device where Fluent Bit is running. If no value is specifies, Fluent Bit will look up the hostname and auto populate its value. If Fluent Bit is unable to find a value, it will set the value `unknown` instead. | _none_ | +| `mac` | The MAC address. This value is optional. | | +| `ip` | The IP address of the local hostname. This value is optional. | | +| `tags` | A list of comma-separated strings to group records in LogDNA and simplify the query with filters. | _none_ | +| `file` | Optional name of a file being monitored. This value is only set if the record doesn't contain a reference to it. | _none_ | +| `app` | Name of the application. This value is automatically discovered on each record. If no value is found, the default value is used. | `Fluent Bit` | +| `workers` | The number of [workers](../administration/multithreading#outputs) to perform flush operations for this output. | `0` | + +## Data discovery and enrichment + +The LogDNA output plugin can automatically discover and enrich records with additional content. + +When the login processes a record or log, it searches for specific key names that might contain context for the record in question. The following table describe these keys and the discovery logic: | Key | Description | | :--- | :--- | -| level | If the record contains a key called `level` or `severity`, it will populate the context `level` key with that value. If not found, the context key is not set. | -| file | if the record contains a key called `file`, it will populate the context `file` with the value found, otherwise If the plugin configuration provided a `file` property, that value will be used instead \(see table above\). | -| app | If the record contains a key called `app`, it will populate the context `app` with the value found, otherwise it will use the value set for `app` in the configuration property \(see table above\). | -| meta | if the record contains a key called `meta`, it will populate the context `meta` with the value found. | +| `level` | If the record contains a key called `level` or `severity`, it will populate the context `level` key with that value. If not found, the context key is not set. | +| `file` | If the record contains a key called `file`, it will populate the context `file` with the value found. Otherwise, if the plugin configuration provided a `file` property, that value will be used instead. | +| `app` | If the record contains a key called `app`, it will populate the context `app` with the value found, otherwise it will use the value set for `app` in the configuration property. | +| `meta` | If the record contains a key called `meta`, it will populate the context `meta` with the value found. | -## Getting Started +## Example configuration -The following configuration example, will emit a dummy example record and ingest it on LogDNA. In your main configuration file append the following: +The following example configuration uses a `dummy` input and `logdna` output: {% tabs %} {% tab title="fluent-bit.yaml" %} @@ -115,13 +44,13 @@ The following configuration example, will emit a dummy example record and ingest service: flush: 1 log_level: info - + pipeline: inputs: - name: dummy dummy: '{"log":"a simple log message", "severity": "INFO", "meta": {"s1": 12345, "s2": true}, "app": "Fluent Bit"}' samples: 1 - + outputs: - name: logdna match: '*' @@ -182,8 +111,8 @@ Fluent Bit output: Your record will be available and visible in your LogDNA dashboard after a few seconds. -### Query your Data in LogDNA +### Query your data in LogDNA -In your LogDNA dashboard, go to the top filters and mark the Tags `aa` and `bb`, then you will be able to see your records as the example below: +In your LogDNA dashboard, go to the top filters and mark the Tags `aa` and `bb`, then you will be able to see your records as shown: -![](../../.gitbook/assets/logdna.png) \ No newline at end of file +![LogDNA dashboard](../../.gitbook/assets/logdna.png) diff --git a/vale-styles/FluentBit/Acronyms.yml b/vale-styles/FluentBit/Acronyms.yml index c7422ef1a..ab5a03c1a 100644 --- a/vale-styles/FluentBit/Acronyms.yml +++ b/vale-styles/FluentBit/Acronyms.yml @@ -61,6 +61,7 @@ exceptions: - LLVM - LTS - LTSV + - MAC - MQTT - MSK - NET diff --git a/vale-styles/FluentBit/Headings.yml b/vale-styles/FluentBit/Headings.yml index fb109ae38..24ec59a14 100644 --- a/vale-styles/FluentBit/Headings.yml +++ b/vale-styles/FluentBit/Headings.yml @@ -61,6 +61,7 @@ exceptions: - Kubernetes - LaunchDarkly - Linux + - LogDNA - LTSV - macOS - Marketplace