Skip to content

[kafka] Surface Kafka Monitoring above the fold in the integration README#23710

Merged
johannbotha merged 4 commits into
masterfrom
jj.botha/kafka-dsm-callout-readme
May 18, 2026
Merged

[kafka] Surface Kafka Monitoring above the fold in the integration README#23710
johannbotha merged 4 commits into
masterfrom
jj.botha/kafka-dsm-callout-readme

Conversation

@johannbotha

@johannbotha johannbotha commented May 14, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Adds a single bold "New:" callout immediately under the dashboard image on the Kafka integration README, linking readers to /data_streams/kafka (the new Kafka Monitoring page on docs.datadoghq.com).

Also consolidates: removes two redundant mid-page lines that already mentioned Data Streams Monitoring (in Overview and Installation sections), and drops two now-orphan reference definitions ([24], [25]).

Motivation

The Kafka integration page is one of the top Datadog pages returned by Google for "kafka datadog". Surfacing the new Kafka Monitoring capability above the fold (instead of buried mid-page) gives readers landing from search a direct path to the new feature.

Wording is per @piochelepiotr's PR-review suggestion — concrete capabilities (consumer lag, throughput, schemas, message reading) instead of a generic "lag/throughput/lineage" pitch.

Links

Tracking

UTM params on the destination link (utm_campaign=DocsCTA-DSMKafka-IntegrationsKafka) so click-through from this page is attributable in web analytics. Shared DSMKafka campaign rollup with the sibling PRs on documentation and corp-hugo.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Add the `qa/skip-qa` label if the PR doesn't need to be tested during QA.

README-only change; tests N/A. Suggest applying `qa/skip-qa`.

AI assistance

Drafted with Claude Code (Claude Opus 4.7); wording, placement, and consolidation reviewed by the author and refined per @piochelepiotr's feedback.

Related PRs

Sibling PRs adding equivalent callouts to other high-traffic Kafka surfaces:

Surfaces /data_streams/kafka above-the-fold for readers landing on the
Kafka integration tile / docs page. UTM params on the link
(utm_campaign=DocsCTA-DSMKafka-IntegrationsKafka) let us attribute
click-through from this specific page in web analytics.

This is one of five high-traffic Kafka pages getting the same treatment;
campaign rollup is DSMKafka.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
johannbotha and others added 3 commits May 14, 2026 14:09
README files are plain markdown and don't render Hugo shortcodes (used in
the sibling docs PR for a boxed callout). Switching to a clean bold
lead-in here so the visual treatment is consistent with other README
"tip"-style callouts and doesn't look like a quote block.

UTM tracking unchanged.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Switches the top callout to the same purple "NEW Kafka Monitoring" box
treatment used in the sibling docs PR, with Piotr's wording (consumer
lag, throughput, schemas, message reading).

Removes two redundant mid-page "Add Data Streams Monitoring..." lines
that duplicated the top callout. Cleans up the now-orphan [24] and
[25] reference definitions.

Per @piochelepiotr's PR comment.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The custom purple HTML box stood out against the rest of the README's
clean markdown. Replaced with a single-line bold lead-in that matches
the file's existing style.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@dd-octo-sts

dd-octo-sts Bot commented May 18, 2026

Copy link
Copy Markdown
Contributor

Validation Report

All 20 validations passed.

Show details
Validation Description Status
agent-reqs Verify check versions match the Agent requirements file
ci Validate CI configuration and Codecov settings
codeowners Validate every integration has a CODEOWNERS entry
config Validate default configuration files against spec.yaml
dep Verify dependency pins are consistent and Agent-compatible
http Validate integrations use the HTTP wrapper correctly
imports Validate check imports do not use deprecated modules
integration-style Validate check code style conventions
jmx-metrics Validate JMX metrics definition files and config
labeler Validate PR labeler config matches integration directories
legacy-signature Validate no integration uses the legacy Agent check signature
license-headers Validate Python files have proper license headers
licenses Validate third-party license attribution list
metadata Validate metadata.csv metric definitions
models Validate configuration data models match spec.yaml
openmetrics Validate OpenMetrics integrations disable the metric limit
package Validate Python package metadata and naming
readmes Validate README files have required sections
saved-views Validate saved view JSON file structure and fields
version Validate version consistency between package and changelog

View full run

@johannbotha johannbotha changed the title [kafka] Add Data Streams Monitoring callout above the fold [kafka] Surface Kafka Monitoring above the fold in the integration README May 18, 2026
@johannbotha johannbotha marked this pull request as ready for review May 18, 2026 18:04
@johannbotha johannbotha requested review from a team as code owners May 18, 2026 18:04
@johannbotha johannbotha added this pull request to the merge queue May 18, 2026
Merged via the queue into master with commit 41967b2 May 18, 2026
70 of 74 checks passed
@johannbotha johannbotha deleted the jj.botha/kafka-dsm-callout-readme branch May 18, 2026 20:47
@dd-octo-sts dd-octo-sts Bot added this to the 7.81.0 milestone May 18, 2026
pull Bot pushed a commit to ConnectionMaster/integrations-core that referenced this pull request May 19, 2026
…3751)

/data_streams/kafka (no trailing slash) returns a 302 to
/data_streams/kafka/ that strips the query string, so the UTM tracking
on the callout link added in DataDog#23710 was being silently dropped before
it reached RUM.

Verified:
  curl -I /data_streams/kafka?utm_campaign=X   -> 302 (UTM lost)
  curl -I /data_streams/kafka/?utm_campaign=X  -> 200 (UTM preserved)

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Comment thread kafka/README.md

The Agent's Kafka check is included in the [Datadog Agent][4] package, no additional installation is needed on your Kafka nodes.

Add [Data Streams Monitoring][24] to your producers and consumers to visualize the application topology, root cause issues across services, and measure end to end latency, throughput and lag.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the rationale for removing all classic DSM links? Save real estate?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO having multiple callouts to DSM will reduce the efficacy of either callout. The callout that is most applicable here is the callout to kafka monitoring so I decided to make that one more prominent .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants