Skip to content

Conversation

@obltmachine
Copy link
Contributor

What

ECS logging specs automatic sync

Why

Changeset


automation: update ECS Logging specs

synchronize ecs-logging spec

1 file(s) updated with "{\n \"version\": 1.0,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/index.html\",\n \"ecs\": {\n \"version\": \"1.x\"\n },\n \"fields\": {\n \"@timestamp\": {\n \"type\": \"datetime\",\n \"required\": true,\n \"index\": 0,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-base.html\",\n \"comment\": [\n \"Field order, as specified by 'index', is RECOMMENDED.\",\n \"ECS loggers must implement field order unless the logging framework makes that impossible.\"\n ]\n },\n \"log.level\": {\n \"type\": \"string\",\n \"required\": true,\n \"index\": 1,\n \"top_level_field\": true,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-log.html\",\n \"comment\": [\n \"This field SHOULD NOT be a nested object field but at the top level with a dot in the property name.\",\n \"This is to make the JSON logs more human-readable.\",\n \"Loggers MAY indent the log level so that the `message` field always starts at the exact same offset,\",\n \"no matter the number of characters the log level has.\",\n \"For example: `'DEBUG'` (5 chars) will not be indented, whereas ` 'WARN'` (4 chars) will be indented by one space character.\"\n ]\n },\n \"message\": {\n \"type\": \"string\",\n \"required\": false,\n \"index\": 2,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-base.html\",\n \"comment\": [\n \"A message field is typically included in all log records, but some logging libraries allow records with no message.\",\n \"That's typically the case for libraries that allow for structured logging.\"\n ]\n },\n \"ecs.version\": {\n \"type\": \"string\",\n \"required\": true,\n \"top_level_field\": true,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-ecs.html\",\n \"comment\": [\n \"This field SHOULD NOT be a nested object field but at the top level with a dot in the property name.\",\n \"This is to make the JSON logs more human-readable.\"\n ]\n },\n \"labels\": {\n \"type\": \"object\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-base.html\",\n \"sanitization\": {\n \"key\": {\n \"replacements\": [\".\", \"*\", \"\\\\\"],\n \"substitute\": \"_\"\n }\n }\n },\n \"trace.id\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-tracing.html\",\n \"comment\": \"When APM agents add this field to the context, ecs loggers should pick it up and add it to the log event.\"\n },\n \"transaction.id\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-tracing.html\",\n \"comment\": \"When APM agents add this field to the context, ecs loggers should pick it up and add it to the log event.\"\n },\n \"service.name\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-service.html\",\n \"comment\": [\n \"Configurable by users.\",\n \"When an APM agent is active, it should auto-configure this field if not already set.\"\n ]\n },\n \"service.node.name\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-service.html\",\n \"comment\": [\n \"Configurable by users.\",\n \"When an APM agent is active and `service_node_name` is manually configured, the agent should auto-configure this field if not already set.\"\n ]\n },\n \"service.version\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-service.html#field-service-version\",\n \"comment\": [\n \"Configurable by users.\",\n \"When an APM agent is active, it should auto-configure it if not already set.\"\n ]\n },\n \"event.dataset\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-event.html\",\n \"default\": \"${service.name} OR ${service.name}.${appender.name}\",\n \"comment\": [\n \"Configurable by users.\",\n \"If the user manually configures the service name,\",\n \"the logging library should set `event.dataset=${service.name}` if not explicitly configured otherwise.\",\n \"\",\n \"When agents auto-configure the app to use an ECS logger,\",\n \"they should set `event.dataset=${service.name}.${appender.name}` if the appender name is available in the logging library.\",\n \"Otherwise, agents should also set `event.dataset=${service.name}`\",\n \"\",\n \"The field helps to filter for different log streams from the same pod, for example and is required for log anomaly detection.\"\n ]\n },\n \"service.environment\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-service.html#field-service-environment\",\n \"comment\": [\n \"Configurable by users.\",\n \"When an APM agent is active, it should auto-configure it if not already set.\"\n ]\n },\n \"process.thread.name\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-process.html\"\n },\n \"log.logger\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-log.html\"\n },\n \"log.origin.file.line\": {\n \"type\": \"integer\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-log.html\",\n \"comment\": \"Should be opt-in as it requires the logging library to capture a stack trace for each log event.\"\n },\n \"log.origin.file.name\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-log.html\",\n \"comment\": \"Should be opt-in as it requires the logging library to capture a stack trace for each log event.\"\n },\n \"log.origin.function\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-log.html\",\n \"comment\": \"Should be opt-in as it requires the logging library to capture a stack trace for each log event.\"\n },\n \"error.type\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-error.html\",\n \"comment\": \"The exception type or class, such as `java.lang.IllegalArgumentException`.\"\n },\n \"error.message\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-error.html\",\n \"comment\": \"The message of the exception.\"\n },\n \"error.stack_trace\": {\n \"type\": \"string\",\n \"required\": false,\n \"url\": \"https://www.elastic.co/guide/en/ecs/current/ecs-error.html\",\n \"comment\": \"The stack trace of the exception as plain text.\"\n }\n }\n}\n": * spec/fixtures/spec/spec.json

GitHub Action workflow link
Updatecli logo

Created automatically by Updatecli

Options:

Most of Updatecli configuration is done via its manifest(s).

  • If you close this pull request, Updatecli will automatically reopen it, the next time it runs.
  • If you close this pull request and delete the base branch, Updatecli will automatically recreate it, erasing all previous commits made.

Feel free to report any issues at github.com/updatecli/updatecli.
If you find this tool useful, do not hesitate to star our GitHub repository as a sign of appreciation, and/or to tell us directly on our chat!

@obltmachine obltmachine added the dependencies Pull requests that update a dependency file label Sep 14, 2024
@elastic-observability-automation elastic-observability-automation bot force-pushed the updatecli_main_apm_ecs-logging-specs branch from 7e24bc2 to f41d9b2 Compare September 19, 2024 06:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent-ruby dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants