From 898c6888b9f5e4cfd319316d8e835450c766ed88 Mon Sep 17 00:00:00 2001 From: svrnm Date: Wed, 22 Nov 2023 10:53:52 +0100 Subject: [PATCH] Prepare markdownlint update Signed-off-by: svrnm --- .../en/community/end-user/discussion-group.md | 4 ++-- content/en/docs/collector/configuration.md | 16 ++++++++-------- content/en/docs/kubernetes/getting-started.md | 12 ++++++------ .../en/docs/kubernetes/operator/automatic.md | 18 +++++++++--------- 4 files changed, 25 insertions(+), 25 deletions(-) diff --git a/content/en/community/end-user/discussion-group.md b/content/en/community/end-user/discussion-group.md index ca6dea8c1e1c..7b84fd5b4867 100644 --- a/content/en/community/end-user/discussion-group.md +++ b/content/en/community/end-user/discussion-group.md @@ -14,7 +14,7 @@ Feedback that is shared and collected in these sessions will be routed back to the relevant project maintainers to help drive prioritization of improvements and changes to the project. -**New for 2023!** +## New for 2023 - Sessions are now available for all regions! - You can now find summaries of past discussions every month! Search the blog @@ -26,7 +26,7 @@ and changes to the project. recorded**. This will help make the feedback more discoverable by the community. -**Upcoming sessions** +## Upcoming sessions Here are upcoming sessions, or you can view them on the [OpenTelemetry calendar](https://github.com/open-telemetry/community#calendar): diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md index a7cca798af5f..8fadb3e1149b 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -18,13 +18,13 @@ Familiarity with the following pages is assumed: The Collector consists of four components that access telemetry data: - [Receivers](#receivers) - + - [Processors](#processors) - + - [Exporters](#exporters) - + - [Connectors](#connectors) - + These components once configured must be enabled via pipelines within the [service](#service) section. @@ -172,7 +172,7 @@ service: exporters: [otlp] ``` -## Receivers {#receivers} +## Receivers {#receivers} A receiver, which can be push or pull based, is how data gets into the Collector. Receivers may support one or more @@ -247,7 +247,7 @@ receivers: zipkin: ``` -## Processors {#processors} +## Processors {#processors} Processors are run on data between being received and being exported. Processors are optional though @@ -328,7 +328,7 @@ processors: separator: '::' ``` -## Exporters {#exporters} +## Exporters {#exporters} An exporter, which can be push or pull based, is how you send data to one or more backends/destinations. Exporters may support one or more @@ -406,7 +406,7 @@ exporters: endpoint: http://localhost:9411/api/v2/spans ``` -## Connectors {#connectors} +## Connectors {#connectors} A connector is both an exporter and receiver. As the name suggests a Connector connects two pipelines: It consumes data as an exporter at the end of one diff --git a/content/en/docs/kubernetes/getting-started.md b/content/en/docs/kubernetes/getting-started.md index 0bc976b3fb0e..4033cebf5d9a 100644 --- a/content/en/docs/kubernetes/getting-started.md +++ b/content/en/docs/kubernetes/getting-started.md @@ -90,7 +90,7 @@ This instance of the collector will use the following components: Let's break these down. -**OTLP Receiver** +### OTLP Receiver The [OTLP Receiver](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver) @@ -105,7 +105,7 @@ a node to emit their traces, metrics, and logs to a collector running on the same node. This keeps network interactions simple and allows easy correlation of Kubernetes metadata using the `k8sattributes` processor. -**Kubernetes Attributes Processor** +### Kubernetes Attributes Processor The [Kubernetes Attributes Processor](../collector/components/#kubernetes-attributes-processor) @@ -117,7 +117,7 @@ Kubernetes context to your telemetry, the Kubernetes Attributes Processor lets you correlate your application's traces, metrics, and logs signals with your Kubernetes telemetry, such as pod metrics and traces. -**Kubeletstats Receiver** +### Kubeletstats Receiver The [Kubeletstats Receiver](../collector/components/#kubeletstats-receiver) is the receiver that gathers metrics about the node. It will gather metrics like @@ -127,7 +127,7 @@ using the Kubernetes Attributes Processor, we'll be able to correlate our application traces, metrics, and logs with the metrics produced by the Kubeletstats Receiver. -**Filelog Receiver** +### Filelog Receiver The [Filelog Receiver](../collector/components/#filelog-receiver) will collect logs written to stdout/stderr by tailing the logs Kubernetes writes to @@ -209,7 +209,7 @@ This instance of the Collector will use the following components: Let's break these down. -**Kubernetes Cluster Receiver** +### Kubernetes Cluster Receiver The [Kubernetes Cluster Receiver](../collector/components/#kubernetes-cluster-receiver) @@ -217,7 +217,7 @@ is the Collector's solution for collecting metrics about the state of the cluster as a whole. This receiver can gather metrics about node conditions, pod phases, container restarts, available and desired deployments, and more. -**Kubernetes Objects Receiver** +### Kubernetes Objects Receiver The [Kubernetes Objects Receiver](../collector/components/#kubernetes-objects-receiver) diff --git a/content/en/docs/kubernetes/operator/automatic.md b/content/en/docs/kubernetes/operator/automatic.md index d899016ab11a..eb52b9afe428 100644 --- a/content/en/docs/kubernetes/operator/automatic.md +++ b/content/en/docs/kubernetes/operator/automatic.md @@ -142,7 +142,7 @@ endpoint must be able to receive OTLP over `http/protobuf`. Therefore, the example uses `http://demo-collector:4318`, which will connect to the `http` port of the `otlpreceiver` of the Collector created in the previous step. -**Excluding auto-instrumentation** +#### Excluding auto-instrumentation {#dotnet-excluding-auto-instrumentation} By default, the .NET auto-instrumentation ships with [many instrumentation libraries](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docs/config.md#instrumentations). @@ -174,7 +174,7 @@ spec: value: false ``` -**Learn more** +#### Learn more {#dotnet-learn-more} For more details, see [.NET Auto Instrumentation docs](/docs/instrumentation/net/automatic/). @@ -208,7 +208,7 @@ must be able to receive OTLP over `grpc`. Therefore, the example uses `http://demo-collector:4317`, which connects to the `grpc` port of the otlpreceiver of the Collector created in the previous step. -**Excluding auto-instrumentation** +#### Excluding auto-instrumentation {#java-excluding-auto-instrumentation} By default, the Java auto-instrumentation ships with [many instrumentation libraries](/docs/instrumentation/java/automatic/#supported-libraries-frameworks-application-services-and-jvms). @@ -244,7 +244,7 @@ spec: value: false ``` -**Learn more** +#### Learn more {#java-learn-more} For more details, see [Java agent Configuration](/docs/instrumentation/java/automatic/agent-config/). @@ -278,7 +278,7 @@ must be able to receive OTLP over `grpc`. Therefore, the example uses `http://demo-collector:4317`, which connects to the `grpc` port of the `otlpreceiver` of the Collector created in the previous step. -**Excluding auto-instrumentation** +#### Excluding auto-instrumentation {#js-excluding-auto-instrumentation} By default, the Node.js auto-instrumentation ships with [many instrumentation libraries](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/metapackages/auto-instrumentations-node/README.md#supported-instrumentations). @@ -287,7 +287,7 @@ specific packages. If you don't want to use a package included by the default image you must either supply your own image that includes only the packages you want or use manual instrumentation. -**Learn more** +#### Learn more {#js-learn-more} For more details, see [Node.js auto-instrumentation](/docs/instrumentation/js/libraries/#registration). @@ -328,7 +328,7 @@ in the previous step. > Operator you **MUST** set these env variables to `http/protobuf`, or Python > auto-instrumentation will not work. -**Auto-instrumenting Python logs** +#### Auto-instrumenting Python logs By default, Python logs auto-instrumentation is disabled. If you would like to enable this feature, you must to set the `OTEL_LOGS_EXPORTER` and @@ -359,7 +359,7 @@ spec: > Note that `OTEL_LOGS_EXPORTER` must be explicitly set to `otlp_proto_http`, > otherwise it defaults to gRPC. -**Excluding auto-instrumentation** +#### Excluding auto-instrumentation {#python-excluding-auto-instrumentation} By default the Python auto-instrumentation will detect the packages in your Python service and instrument anything it can. This makes instrumentation easy, @@ -389,7 +389,7 @@ spec: instrumentation> ``` -**Learn more** +#### Learn more {#python-learn-more} [See the Python agent Configuration docs for more details.](/docs/instrumentation/python/automatic/agent-config/#disabling-specific-instrumentations)