K8s annotation discovery blogpost #5967

ChrsMark · 2025-01-17T19:23:09Z

This PR adds a blog post about the new functionality of the Opentelemetry Collector which was introduced with open-telemetry/opentelemetry-collector-contrib#34427.

With this new feature now the Collector provides support for dynamic workload discovery based on Kubernetes Pods's annotations.

Preview: https://deploy-preview-5967--opentelemetry.netlify.app/blog/2025/otel-collector-k8s-discovery/

/cc @dmitryax

ChrsMark · 2025-01-17T20:00:38Z

FYI @open-telemetry/docs-maintainers sth is odd with the 2025 index page and I cannot find the preview page that is built. I assume it's because there is no prior blog post for 2025 and something is missing there but not sure what.

svrnm

A first pass! This is a really great feature I was not aware coming, so great to have a blog post.

Note: we should also think about turning some of that into documentation immediatly otherwise this gets dated and people will refer to it as docs, would you be able to provide that as well? Could be a very basic page with an example to begin with

svrnm · 2025-01-20T08:47:39Z

content/en/blog/2025/otel-collector-k8s-discovery/index.md

+author: >
+  [Dmitrii Anoshin](https://github.com/dmitryax) (Cisco/Splunk), [Christos
+  Markou](https://github.com/ChrsMark) (Elastic)
+cSpell:ignore: Dmitrii Anoshin Markou


Suggested change

cSpell:ignore: Dmitrii Anoshin Markou

sig: Collector

issue: opentelemetry-collector-contrib#34427

cSpell:ignore: Dmitrii Anoshin Markou

We ask SIG members as well to make sure that their blog posts are sponsored, I assume that the Collector SIG has agreed to publish this and is going to review, so I will not ask you to raise an additional issue, but please add these annotations (see https://opentelemetry.io/docs/contributing/blog/ for more details)

Ah good to know. I will also share it with the Collector SIG to check if there is any objection/feedback from the wider group.

svrnm · 2025-01-20T08:47:53Z

content/en/blog/2025/otel-collector-k8s-discovery/index.md

+cSpell:ignore: Dmitrii Anoshin Markou
+---
+
+In the world of containers and Kubernetes, observability is crucial. Users need


Suggested change

In the world of containers and Kubernetes, observability is crucial. Users need

In the world of containers and [Kubernetes](https://kubernetes.io/), observability is crucial. Users need

svrnm · 2025-01-20T08:50:16Z

content/en/blog/2025/otel-collector-k8s-discovery/index.md

+that makes dynamic workload discovery even easier, providing a seamless
+experience for both administrators and users.
+
+## What is Autodiscovery in Observability?


Suggested change

## What is Autodiscovery in Observability?

## Automatic discovery for containers and pods

Is "Autodiscovery" a specific term for this technique, or is this section explaining how auto discovery works? The text does not give any hint on "what" but provides a "how"

svrnm · 2025-01-20T08:50:24Z

content/en/blog/2025/otel-collector-k8s-discovery/index.md

+## What is Autodiscovery in Observability?
+
+Applications running on containers and pods become moving targets for the
+monitoring system. With autodiscovery, monitoring agents like the Collector can


Suggested change

monitoring system. With autodiscovery, monitoring agents like the Collector can

monitoring system. With automatic discovery, monitoring agents like the Collector can

svrnm · 2025-01-20T08:51:16Z

content/en/blog/2025/otel-collector-k8s-discovery/index.md

+```
+
+The above configuration will be enabled when a pod is discovered via the
+Kubernetes API that exposes port 6379 (the known port for Redis).


Suggested change

Kubernetes API that exposes port 6379 (the known port for Redis).

Kubernetes API that exposes port `6379` (the known port for Redis).

svrnm · 2025-01-20T08:51:53Z

content/en/blog/2025/otel-collector-k8s-discovery/index.md

+configuration "templates" that rely on environment conditions. For example, as
+an observability engineer, I can configure my Collector to enable the
+[Redis receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.117.0/receiver/redisreceiver)
+when a Redis pod is deployed on the cluster. The following configuration can


maybe I am very pedantic here, but since Redis is no longer open source, wouldn't it be better to pick something wie an OSI-approved open source license for the example?

I can use NGINX which is our example further down as well.

yes, that would be great!

ChrsMark · 2025-01-20T11:58:37Z

A first pass! This is a really great feature I was not aware coming, so great to have a blog post.

Note: we should also think about turning some of that into documentation immediatly otherwise this gets dated and people will refer to it as docs, would you be able to provide that as well? Could be a very basic page with an example to begin with

Thank's for reviewing @svrnm! About turning this into documentation: I linked the last paragraph to the perspective documentation of that feature in the Collector: https://github.com/open-telemetry/opentelemetry.io/pull/5967/files#diff-4fa372b70b4ce1ad702b596ad6f06decb547f6de4dd4ca979ffeee2bac298f72R182. Would we need more than this?

svrnm · 2025-01-20T13:50:10Z

A first pass! This is a really great feature I was not aware coming, so great to have a blog post.
Note: we should also think about turning some of that into documentation immediatly otherwise this gets dated and people will refer to it as docs, would you be able to provide that as well? Could be a very basic page with an example to begin with

Thank's for reviewing @svrnm! About turning this into documentation: I linked the last paragraph to the perspective documentation of that feature in the Collector: #5967 (files). Would we need more than this?

I mean adding a section/page somewhere in https://opentelemetry.io/docs/collector/

ChrsMark · 2025-01-20T15:20:04Z

I mean adding a section/page somewhere in https://opentelemetry.io/docs/collector/

My only concern would be that we would need to maintain that source in addition to receiver's README, right?
If we find value in doing this I'm fine filing an issue and assigning it to me.

andrzej-stencel

Looks great to me 🚀 Just a couple nits/typos. with the caveats that I'm not a native English speaker, so my suggestions might be incorrect. Feel free to discard them.

content/en/blog/2025/otel-collector-k8s-discovery/index.md

chalin

Some initial comments.

chalin · 2025-01-23T00:17:34Z

content/en/blog/2025/otel-collector-k8s-discovery/index.md

If there is only this one file, then rename this to content/en/blog/2025/otel-collector-k8s-discovery.md.

Sure! Done.

content/en/blog/2025/otel-collector-k8s-discovery/index.md

chalin · 2025-01-23T00:34:07Z

Preview is now up: https://deploy-preview-5967--opentelemetry.netlify.app/blog/2025/otel-collector-k8s-discovery/

chalin · 2025-01-23T00:37:21Z

/fix:all

opentelemetrybot · 2025-01-23T00:37:33Z

You triggered fix:all action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/12919783314

opentelemetrybot · 2025-01-23T00:42:29Z

fix:all was successful.

IMPORTANT: (RE-)RUN `/fix:all` to ensure that there are no remaining check issues.

content/en/blog/2025/otel-collector-k8s-discovery/index.md

static/refcache.json

Co-authored-by: Dmitrii Anoshin <[email protected]> Signed-off-by: ChrsMark <[email protected]>

Co-authored-by: Patrice Chalin <[email protected]>

Signed-off-by: ChrsMark <[email protected]>

ChrsMark requested a review from a team as a code owner January 17, 2025 19:23

opentelemetrybot requested a review from a team January 17, 2025 19:23

github-actions bot added the blog label Jan 17, 2025

ChrsMark force-pushed the add_k8s_discovery_blogpost branch 5 times, most recently from e8de438 to f6215ae Compare January 17, 2025 19:39

svrnm reviewed Jan 20, 2025

View reviewed changes

ChrsMark force-pushed the add_k8s_discovery_blogpost branch from f6215ae to 3183ec2 Compare January 20, 2025 10:21

opentelemetrybot requested a review from a team January 20, 2025 10:21

ChrsMark force-pushed the add_k8s_discovery_blogpost branch 3 times, most recently from 3763d98 to d6bcd8c Compare January 20, 2025 11:55

andrzej-stencel approved these changes Jan 22, 2025

View reviewed changes

ChrsMark force-pushed the add_k8s_discovery_blogpost branch 2 times, most recently from 854f6a1 to f6a43c2 Compare January 22, 2025 09:22

chalin requested changes Jan 23, 2025

View reviewed changes

chalin reviewed Jan 23, 2025

View reviewed changes

content/en/blog/2025/otel-collector-k8s-discovery/index.md Outdated Show resolved Hide resolved

opentelemetrybot requested a review from a team January 23, 2025 00:31

chalin changed the title ~~[Opentelemetry Collector] Add k8s annotation discovery blogpost~~ K8s annotation discovery blogpost Jan 23, 2025

chalin reviewed Jan 23, 2025

View reviewed changes

content/en/blog/2025/otel-collector-k8s-discovery/index.md Outdated Show resolved Hide resolved

chalin force-pushed the add_k8s_discovery_blogpost branch from 67993ab to 0eb852e Compare January 23, 2025 00:34

opentelemetrybot requested a review from a team January 23, 2025 00:34

chalin force-pushed the add_k8s_discovery_blogpost branch from 187d487 to ef477e5 Compare January 23, 2025 02:05

chalin reviewed Jan 23, 2025

View reviewed changes

content/en/blog/2025/otel-collector-k8s-discovery/index.md Outdated Show resolved Hide resolved

chalin reviewed Jan 23, 2025

View reviewed changes

static/refcache.json Outdated Show resolved Hide resolved

opentelemetrybot requested a review from a team January 23, 2025 08:26

ChrsMark and others added 5 commits January 23, 2025 10:33

Add k8s annotation discovery blogpost

a78aa71

Co-authored-by: Dmitrii Anoshin <[email protected]> Signed-off-by: ChrsMark <[email protected]>

Set date so that we get a preview

ef1541e

Results from /fix:all

677d73e

Update content/en/blog/2025/otel-collector-k8s-discovery/index.md

f8ad34f

Co-authored-by: Patrice Chalin <[email protected]>

Apply suggestions from code review

99b4e01

Co-authored-by: Patrice Chalin <[email protected]>

ChrsMark force-pushed the add_k8s_discovery_blogpost branch from 9608188 to 99b4e01 Compare January 23, 2025 08:33

ChrsMark added 2 commits January 23, 2025 10:38

rename file

cd61c1b

Signed-off-by: ChrsMark <[email protected]>

minor fix and fmt

3018504

Signed-off-by: ChrsMark <[email protected]>

ChrsMark force-pushed the add_k8s_discovery_blogpost branch from 623fb64 to 3018504 Compare January 23, 2025 08:58

ChrsMark requested review from chalin and svrnm January 23, 2025 14:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

K8s annotation discovery blogpost #5967

K8s annotation discovery blogpost #5967

ChrsMark commented Jan 17, 2025 •

edited

Loading

ChrsMark commented Jan 17, 2025

svrnm left a comment

svrnm Jan 20, 2025

ChrsMark Jan 20, 2025

svrnm Jan 20, 2025

ChrsMark Jan 20, 2025

svrnm Jan 20, 2025

ChrsMark Jan 20, 2025

svrnm Jan 20, 2025

ChrsMark Jan 20, 2025

svrnm Jan 20, 2025

svrnm Jan 20, 2025

ChrsMark Jan 20, 2025

svrnm Jan 20, 2025

ChrsMark Jan 20, 2025

ChrsMark commented Jan 20, 2025

svrnm commented Jan 20, 2025

ChrsMark commented Jan 20, 2025

andrzej-stencel left a comment

chalin left a comment

chalin Jan 23, 2025

ChrsMark Jan 23, 2025

chalin commented Jan 23, 2025

chalin commented Jan 23, 2025

opentelemetrybot commented Jan 23, 2025

opentelemetrybot commented Jan 23, 2025

	In the world of containers and Kubernetes, observability is crucial. Users need
	In the world of containers and [Kubernetes](https://kubernetes.io/), observability is crucial. Users need

	## What is Autodiscovery in Observability?
	## Automatic discovery for containers and pods

	monitoring system. With autodiscovery, monitoring agents like the Collector can
	monitoring system. With automatic discovery, monitoring agents like the Collector can

	Kubernetes API that exposes port 6379 (the known port for Redis).
	Kubernetes API that exposes port `6379` (the known port for Redis).

K8s annotation discovery blogpost #5967

Are you sure you want to change the base?

K8s annotation discovery blogpost #5967

Conversation

ChrsMark commented Jan 17, 2025 • edited Loading

ChrsMark commented Jan 17, 2025

svrnm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ChrsMark commented Jan 20, 2025

svrnm commented Jan 20, 2025

ChrsMark commented Jan 20, 2025

andrzej-stencel left a comment

Choose a reason for hiding this comment

chalin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chalin commented Jan 23, 2025

chalin commented Jan 23, 2025

opentelemetrybot commented Jan 23, 2025

opentelemetrybot commented Jan 23, 2025

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

ChrsMark commented Jan 17, 2025 •

edited

Loading

IMPORTANT: (RE-)RUN `/fix:all` to ensure that there are no remaining check issues.