You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[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.
4
-
5
-
The Fluent Bit `logdna` output plugin allows you to send your log or events to a [LogDNA](https://logdna.com/) compliant service like:
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:
11
-
12
-
*[LogDNA Sign Up ](https://logdna.com/sign-up/)
13
-
14
-
## Configuration Parameters
15
-
16
-
<table>
17
-
<thead>
18
-
<tr>
19
-
<th style="text-align:left">Key</th>
20
-
<th style="text-align:left">Description</th>
21
-
<th style="text-align:left">Default</th>
22
-
</tr>
23
-
</thead>
24
-
<tbody>
25
-
<tr>
26
-
<td style="text-align:left">logdna_host</td>
27
-
<td style="text-align:left">LogDNA API host address</td>
<td style="text-align:left">API key to get access to the service. This property is <b>mandatory</b>.</td>
43
-
<td
44
-
style="text-align:left"></td>
45
-
</tr>
46
-
<tr>
47
-
<td style="text-align:left">hostname</td>
48
-
<td style="text-align:left">
49
-
<p>Name of the local machine or device where Fluent Bit is running.
50
-
<br />
51
-
</p>
52
-
<p>When this value is not set, Fluent Bit lookup the hostname and auto populate
53
-
the value. If it cannot be found, an <code>unknown</code> value will be set
54
-
instead.</p>
55
-
</td>
56
-
<td style="text-align:left"></td>
57
-
</tr>
58
-
<tr>
59
-
<td style="text-align:left">mac</td>
60
-
<td style="text-align:left">Mac address. This value is optional.</td>
61
-
<td style="text-align:left"></td>
62
-
</tr>
63
-
<tr>
64
-
<td style="text-align:left">ip</td>
65
-
<td style="text-align:left">IP address of the local hostname. This value is optional.</td>
66
-
<td style="text-align:left"></td>
67
-
</tr>
68
-
<tr>
69
-
<td style="text-align:left">tags</td>
70
-
<td style="text-align:left">A list of comma separated strings to group records in LogDNA and simplify
71
-
the query with filters.</td>
72
-
<td style="text-align:left"></td>
73
-
</tr>
74
-
<tr>
75
-
<td style="text-align:left">file</td>
76
-
<td style="text-align:left">Optional name of a file being monitored. Note that this value is only
77
-
set if the record do not contain a reference to it.</td>
78
-
<td style="text-align:left"></td>
79
-
</tr>
80
-
<tr>
81
-
<td style="text-align:left">app</td>
82
-
<td style="text-align:left">Name of the application. This value is auto discovered on each record,
83
-
if not found, the default value is used.</td>
84
-
<td style="text-align:left">Fluent Bit</td>
85
-
</tr>
86
-
<tr>
87
-
<td style="text-align:left">workers</td>
88
-
<td style="text-align:left">The number of <a href="https://docs.fluentbit.io/manual/administration/multithreading#outputs">workers</a> to perform flush operations for this output.</td>
89
-
<td style="text-align:left">`0`</td>
90
-
</tr>
91
-
</tbody>
92
-
</table>
93
-
94
-
## Auto Enrichment & Data Discovery
95
-
96
-
One of the features of Fluent Bit + LogDNA integration is the ability to auto enrich each record with further context.
97
-
98
-
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:
3
+
The _LogDNA_ output plugin sends logs and events to a LogDNA-compliant service.
4
+
5
+
## Configuration parameters
6
+
7
+
This plugin uses the following configuration parameters:
8
+
9
+
| Key | Description | Default |
10
+
| --- | ----------- | ------- |
11
+
|`logdna_host`| The LogDNA API host address. |`logs.logdna.com`|
12
+
|`logdna_port`| The LogDNA TCP Port. |`443`|
13
+
|`logdna_endpoint`| The LogDNA ingestion endpoint. |`/logs/ingest`|
14
+
|`api_key`| Required. The API key to get access to the service. |_none_|
15
+
|`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_|
16
+
|`mac`| The MAC address. This value is optional. ||
17
+
|`ip`| The IP address of the local hostname. This value is optional. ||
18
+
|`tags`| A list of comma-separated strings to group records in LogDNA and simplify the query with filters. |_none_|
19
+
|`file`| Optional name of a file being monitored. This value is only set if the record doesn't contain a reference to it. |_none_|
20
+
|`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`|
21
+
|`workers`| The number of [workers](../administration/multithreading#outputs) to perform flush operations for this output. |`0`|
22
+
23
+
## Data discovery and enrichment
24
+
25
+
The LogDNA output plugin can automatically discover and enrich records with additional content.
26
+
27
+
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:
99
28
100
29
| Key | Description |
101
30
| :--- | :--- |
102
-
| 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. |
103
-
| 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\). |
104
-
| 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\). |
105
-
| meta |if the record contains a key called `meta`, it will populate the context `meta` with the value found. |
31
+
|`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. |
32
+
|`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. |
33
+
|`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. |
34
+
|`meta`|If the record contains a key called `meta`, it will populate the context `meta` with the value found. |
106
35
107
-
## Getting Started
36
+
## Example configuration
108
37
109
-
The following configuration example, will emit a dummy example record and ingest it on LogDNA. In your main configuration file append the following:
38
+
The following example configuration uses a `dummy` input and `logdna` output:
110
39
111
40
{% tabs %}
112
41
{% tab title="fluent-bit.yaml" %}
@@ -115,13 +44,13 @@ The following configuration example, will emit a dummy example record and ingest
0 commit comments