From 5c4aec4c3d7c63ffd8834305846d70d02625fba5 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Fri, 28 Feb 2025 12:01:06 -0600 Subject: [PATCH] clean up cross-repo links --- docs/reference/_formatters.md | 14 +++++++------- .../reference/extensions-logging-data-shipper.md | 4 ++-- docs/reference/index.md | 2 +- docs/reference/log4net-formatter.md | 2 +- docs/reference/setup.md | 16 ++++++++-------- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/reference/_formatters.md b/docs/reference/_formatters.md index cf806666..85146823 100644 --- a/docs/reference/_formatters.md +++ b/docs/reference/_formatters.md @@ -33,7 +33,7 @@ We also support writing logs directly to Elasticsearch or Elastic Cloud. See our :::::::{tab-set} ::::::{tab-item} Log file -1. Follow the [Filebeat quick start](beats://docs/reference/filebeat/filebeat-installation-configuration.md) +1. Follow the [Filebeat quick start](beats://reference/filebeat/filebeat-installation-configuration.md) 2. Add the following configuration to your `filebeat.yaml` file. For Filebeat 7.16+ @@ -59,7 +59,7 @@ processors: <5> 2. Values from the decoded JSON object overwrite the fields that {{filebeat}} normally adds (type, source, offset, etc.) in case of conflicts. 3. {{filebeat}} adds an "error.message" and "error.type: json" key in case of JSON unmarshalling errors. 4. {{filebeat}} will recursively de-dot keys in the decoded JSON, and expand them into a hierarchical object structure. -5. Processors enhance your data. See [processors](beats://docs/reference/filebeat/filtering-enhancing-data.md) to learn more. +5. Processors enhance your data. See [processors](beats://reference/filebeat/filtering-enhancing-data.md) to learn more. For Filebeat < 7.16 @@ -83,8 +83,8 @@ processors: ::::::{tab-item} Kubernetes 1. Make sure your application logs to stdout/stderr. -2. Follow the [Run Filebeat on Kubernetes](beats://docs/reference/filebeat/running-on-kubernetes.md) guide. -3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`). +2. Follow the [Run Filebeat on Kubernetes](beats://reference/filebeat/running-on-kubernetes.md) guide. +3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`). 4. Add these annotations to your pods that log using ECS loggers. This will make sure the logs are parsed appropriately. ```yaml @@ -101,8 +101,8 @@ annotations: ::::::{tab-item} Docker 1. Make sure your application logs to stdout/stderr. -2. Follow the [Run Filebeat on Docker](beats://docs/reference/filebeat/running-on-docker.md) guide. -3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md). +2. Follow the [Run Filebeat on Docker](beats://reference/filebeat/running-on-docker.md) guide. +3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md). 4. Add these labels to your containers that log using ECS loggers. This will make sure the logs are parsed appropriately. ```yaml @@ -118,7 +118,7 @@ labels: :::::: ::::::: -For more information, see the [Filebeat reference](beats://docs/reference/filebeat/configuring-howto-filebeat.md). +For more information, see the [Filebeat reference](beats://reference/filebeat/configuring-howto-filebeat.md). diff --git a/docs/reference/extensions-logging-data-shipper.md b/docs/reference/extensions-logging-data-shipper.md index a34a9953..ddf61997 100644 --- a/docs/reference/extensions-logging-data-shipper.md +++ b/docs/reference/extensions-logging-data-shipper.md @@ -7,7 +7,7 @@ mapped_pages: Elastic logger provider for Microsoft.Extensions.Logging. -Writes direct to Elasticsearch using the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)), with semantic logging of structured data from message and scope values. The results can be viewed and queried in the Kibana console. +Writes direct to Elasticsearch using the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)), with semantic logging of structured data from message and scope values. The results can be viewed and queried in the Kibana console. ## Installation [_installation_7] @@ -147,7 +147,7 @@ If `CloudId` is provided, the `ConnectionPoolType` defaults to `Cloud`: ## Output - Elastic Common Schema (ECS) [_output_elastic_common_schema_ecs] -Log messages sent to Elasticsearch follow the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). +Log messages sent to Elasticsearch follow the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). ## Example document [_example_document] diff --git a/docs/reference/index.md b/docs/reference/index.md index 6a3c1c0e..7c36fb59 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -10,7 +10,7 @@ mapped_pages: ECS logging are integrations for your favorite .NET logging libraries. They make it easy to format your logs into ECS-compatible JSON. ::::{tip} -Want to learn more about ECS, ECS logging, and other available language plugins? See the [ECS logging overview](ecs-logging://docs/reference/intro.md). +Want to learn more about ECS, ECS logging, and other available language plugins? See the [ECS logging overview](ecs-logging://reference/intro.md). :::: diff --git a/docs/reference/log4net-formatter.md b/docs/reference/log4net-formatter.md index c3b43cbc..68226177 100644 --- a/docs/reference/log4net-formatter.md +++ b/docs/reference/log4net-formatter.md @@ -56,7 +56,7 @@ Any valid ECS log template properties that is available under `LogTemplateProper ## Output [_output] -Apart from [mandatory fields](ecs://docs/reference/ecs-guidelines.md#_general_guidelines), the output contains additional data: +Apart from [mandatory fields](ecs://reference/ecs-guidelines.md#_general_guidelines), the output contains additional data: * `log.origin.file.name` is taken from `LocationInformation` * `log.origin.file.line` is taken from `LocationInformation` diff --git a/docs/reference/setup.md b/docs/reference/setup.md index 373e9059..e8125f69 100644 --- a/docs/reference/setup.md +++ b/docs/reference/setup.md @@ -27,7 +27,7 @@ Choose one of our data shipping loggers: ## Step 2: Enable APM log correlation (optional) [setup-step-2] -If you are using the Elastic APM .NET agent, [log correlation can be configured](apm-agent-dotnet://docs/reference/logs.md) to inject trace, transaction and span id fields into log events. +If you are using the Elastic APM .NET agent, [log correlation can be configured](apm-agent-dotnet://reference/logs.md) to inject trace, transaction and span id fields into log events. By default the ECS logging integrations will read tracing information from [System.Diagnostics.Activity](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.activity?view=net-7.0) if the APM logging corrolation libraries are not installed. @@ -39,7 +39,7 @@ If you are using one of our log formatters you can use the following methods to :::::::{tab-set} ::::::{tab-item} Log file -1. Follow the [Filebeat quick start](beats://docs/reference/filebeat/filebeat-installation-configuration.md) +1. Follow the [Filebeat quick start](beats://reference/filebeat/filebeat-installation-configuration.md) 2. Add the following configuration to your `filebeat.yaml` file. For Filebeat 7.16+ @@ -65,7 +65,7 @@ processors: <5> 2. Values from the decoded JSON object overwrite the fields that {{filebeat}} normally adds (type, source, offset, etc.) in case of conflicts. 3. {{filebeat}} adds an "error.message" and "error.type: json" key in case of JSON unmarshalling errors. 4. {{filebeat}} will recursively de-dot keys in the decoded JSON, and expand them into a hierarchical object structure. -5. Processors enhance your data. See [processors](beats://docs/reference/filebeat/filtering-enhancing-data.md) to learn more. +5. Processors enhance your data. See [processors](beats://reference/filebeat/filtering-enhancing-data.md) to learn more. For Filebeat < 7.16 @@ -89,8 +89,8 @@ processors: ::::::{tab-item} Kubernetes 1. Make sure your application logs to stdout/stderr. -2. Follow the [Run Filebeat on Kubernetes](beats://docs/reference/filebeat/running-on-kubernetes.md) guide. -3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`). +2. Follow the [Run Filebeat on Kubernetes](beats://reference/filebeat/running-on-kubernetes.md) guide. +3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`). 4. Add these annotations to your pods that log using ECS loggers. This will make sure the logs are parsed appropriately. ```yaml @@ -107,8 +107,8 @@ annotations: ::::::{tab-item} Docker 1. Make sure your application logs to stdout/stderr. -2. Follow the [Run Filebeat on Docker](beats://docs/reference/filebeat/running-on-docker.md) guide. -3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md). +2. Follow the [Run Filebeat on Docker](beats://reference/filebeat/running-on-docker.md) guide. +3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md). 4. Add these labels to your containers that log using ECS loggers. This will make sure the logs are parsed appropriately. ```yaml @@ -124,5 +124,5 @@ labels: :::::: ::::::: -For more information, see the [Filebeat reference](beats://docs/reference/filebeat/configuring-howto-filebeat.md). +For more information, see the [Filebeat reference](beats://reference/filebeat/configuring-howto-filebeat.md).