diff --git a/.chloggen/add-k8s-resolver-docs.yaml b/.chloggen/add-k8s-resolver-docs.yaml new file mode 100644 index 000000000000..1706bb1400f5 --- /dev/null +++ b/.chloggen/add-k8s-resolver-docs.yaml @@ -0,0 +1,20 @@ +# Use this changelog template to create an entry for release notes. +# If your change doesn't affect end users, such as a test fix or a tooling change, +# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: 'enhancement' + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: loadbalancingexporter + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Added docs for k8s service resolver. + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [24287] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: diff --git a/exporter/loadbalancingexporter/README.md b/exporter/loadbalancingexporter/README.md index 34b7b9741155..999f7da1d744 100644 --- a/exporter/loadbalancingexporter/README.md +++ b/exporter/loadbalancingexporter/README.md @@ -97,7 +97,7 @@ service: - loadbalancing ``` -Kubernetes resolver example +Kubernetes resolver example (For a more specific example: [example/k8s-resolver](./example/k8s-resolver/README.md)) ```yaml receivers: otlp: diff --git a/exporter/loadbalancingexporter/example/k8s-resolver/README.md b/exporter/loadbalancingexporter/example/k8s-resolver/README.md new file mode 100644 index 000000000000..bfe41baaff36 --- /dev/null +++ b/exporter/loadbalancingexporter/example/k8s-resolver/README.md @@ -0,0 +1,121 @@ +# Trace ID aware load-balancing exporter demo for kubernetes service resolver + +## How to run + +1. Pre-requirements: +```shell +kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml +``` + +2. Once the opentelemetry-operator is deployed, create the OpenTelemetry Collector (otelcol) instances, ServiceAccount and other necessary resources, run: +```shell +kubectl apply -f - <