Skip to content

Commit 17f11c1

Browse files
authored
Proposing a formatter allow-list configuration (#440)
1 parent 797e279 commit 17f11c1

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

specs/agents/log-onboarding.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,22 @@ app as ECS-compatible json, as shown in the
3737
[spec](https://github.com/elastic/ecs-logging/blob/master/spec/spec.json).
3838

3939
For all options other than `off`, the [log correlation](log-correlation.md) should be implicitly enabled.
40-
### Required fields
40+
41+
## `log_ecs_formatter_allow_list` configuration
42+
43+
Only formatters that match an item on this list will be automatically reformatted to ECS when `log_ecs_formatting` is
44+
set to any option other than `off`. A "formatter" is a generic name used to describe the logging-framework-specific entity
45+
that is responsible for the formatting of log events. Currently this option is only implemented in the Java agent, where
46+
formatters are subtypes of `Layout` or `Encoder`, depending on the logging framework.
47+
48+
| | |
49+
|----------------|---|
50+
| Type | `List<`[`WildcardMatcher`](../../tests/agents/json-specs/wildcard_matcher_tests.json)`>` |
51+
| Default | agent specific |
52+
| Dynamic | `false` |
53+
| Central config | `false` |
54+
55+
## Required fields
4156

4257
The following fields are required:
4358

@@ -46,12 +61,12 @@ The following fields are required:
4661
* `message`
4762
* `ecs.version`
4863

49-
### Recommended fields
64+
## Recommended fields
5065

5166
The following fields are important for a good user experience in Kibana,
5267
but will not cause errors if they are omitted:
5368

54-
#### `service.name`
69+
### `service.name`
5570

5671
Agents should always populate `service.name` even if there is not an active
5772
transaction.
@@ -60,7 +75,7 @@ The `service.name` is used to be able to add a logs tab to the service view in
6075
the UI. This lets users quickly get a stream of all logs for a particular
6176
service.
6277

63-
#### `event.dataset`
78+
### `event.dataset`
6479

6580
The `event.dataset` field is used to power the [log anomaly chart in the logs UI](https://www.elastic.co/guide/en/observability/current/inspect-log-anomalies.html#anomalies-chart).
6681
The dataset can also be useful to filter for different log streams from the same pod, for example.

0 commit comments

Comments
 (0)