Skip to content

docs: add SAP Cloud ALM (beta) section, carve out telemetry-to-caas - #516

Merged
sjvans merged 2 commits into
developfrom
docs/calm-section-and-carve-out-caas
Sep 22, 2026
Merged

sjvans merged 2 commits into
developfrom
docs/calm-section-and-carve-out-caas

Conversation

@sjvans

@sjvans sjvans commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

What

  • New section: Running with SAP Cloud ALM (beta). Documents that when @sap/xotel-agent-ext-js is present, the plugin detects it and contributes its CDS spans to the agent's tracing pipeline (delegate on the shared span processor) instead of standing up its own tracer provider — the OTel-2.0-compatible coexistence tracked in Can this project be used to provide data to SAP Cloud ALM? #99. Marked beta; refers to SAP Cloud ALM's own docs for agent onboarding; notes the CALM + Dynatrace OneAgent combination is unsupported.
  • Carve out telemetry-to-caas. The heavy CaaS deployment recipe (collector instance creation, ZTI sidecar mta.yaml, certificate-identity workaround, manual mTLS) is removed from the public README and moved to the internal golden-path docs, where the audience and internal links belong. The kind's TOC entry is removed too.

Why

  • CALM coexistence is now demand-driven (Can this project be used to provide data to SAP Cloud ALM? #99) and works on OTel 2.0 via the delegate path; documenting it (beta) gives users a supported story.
  • The CaaS recipe is deployment/onboarding content for an internal offering — it fits golden-path, not the plugin's public API reference.

Net: README is +11 / −101 lines.

Requirements

CALM coexistence requires @sap/xotel-agent-ext-js 2.0.4 or later.

Closes #99

The CaaS deployment recipe (instance creation, ZTI sidecar, mTLS) moves to
the golden-path docs; the public README no longer documents it. Adds a beta
section describing coexistence with the SAP Cloud ALM agent.
@sjvans
sjvans requested a review from a team as a code owner September 22, 2026 08:57
@hyperspace-pr-bot

Copy link
Copy Markdown
Contributor

Summary

The following content is AI-generated and provides a summary of the pull request:


Document SAP Cloud ALM Beta Coexistence and Remove CaaS Recipe

Documentation

📚 Adds public README guidance for running @cap-js/telemetry alongside the SAP Cloud ALM agent extension in beta, while removing the detailed CaaS deployment walkthrough from the public documentation.

Changes

  • README.md: Added a new Running with SAP Cloud ALM (beta) section explaining that when @sap/xotel-agent-ext-js is present, @cap-js/telemetry contributes CDS spans to the agent-owned OpenTelemetry tracing pipeline instead of initializing its own tracer provider.
  • README.md: Clarified that SAP Cloud ALM onboarding should follow SAP Cloud ALM documentation and noted that combining SAP Cloud ALM with Dynatrace OneAgent is unsupported.
  • README.md: Removed the telemetry-to-caas section from the public README, including CaaS collector setup, ZTI sidecar configuration, certificate identity workaround, and manual mTLS guidance.
  • README.md: Updated the table of contents by removing telemetry-to-caas and adding the SAP Cloud ALM beta section.

GitHub Issues

  • #99: Can this project be used to provide data to SAP Cloud ALM?

Images and Links


  • 🔄 Regenerate and Update Summary
  • ✏️ Insert as PR Description (deletes this comment)
  • 🗑️ Delete comment
PR Bot Information

Version: 1.31.48

@hyperspace-pr-bot hyperspace-pr-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The review has been concluded!

PR Bot Information

Version: 1.31.48

  • File Content Strategy: Full file content
  • Correlation ID: a05b6dc0-b663-11f1-949f-643e3eb3ff3f
  • LLM: gpt-5.5
  • Event Trigger: pull_request.opened

@sjvans
sjvans merged commit e50079c into develop Sep 22, 2026
8 checks passed
@sjvans
sjvans deleted the docs/calm-section-and-carve-out-caas branch September 22, 2026 09:42
@sjvans sjvans mentioned this pull request Sep 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant