Skip to content

[ess_billing] Clarify integration covers Hosted, Serverless, and cloud connected usage#20020

Merged
shmsr merged 6 commits into
elastic:mainfrom
briannebartlett:docs/ess-billing-clarify-cloud-coverage
Jul 9, 2026
Merged

[ess_billing] Clarify integration covers Hosted, Serverless, and cloud connected usage#20020
shmsr merged 6 commits into
elastic:mainfrom
briannebartlett:docs/ess-billing-clarify-cloud-coverage

Conversation

@briannebartlett

Copy link
Copy Markdown
Contributor

Summary

  • Add a Supported Elastic Cloud products section to the ESS Billing integration docs clarifying coverage for Hosted deployments, Serverless projects, Cloud Connect usage (e.g., EIS), and other org-level services
  • Update package/manifest copy to use Elastic Cloud Billing API terminology instead of legacy "Elasticsearch Service" framing
  • Clarify that ess.billing.deployment_* fields represent any billed instance type (backward-compatible naming)
  • Fix typo: "Cloud Hosted of Serverless" → "Cloud Hosted or Serverless"

Motivation

We get frequent questions about whether this integration applies to Hosted vs. Serverless. The integration has supported Serverless since v1.5.0, but the docs still read as ESS/deployment-only. This change makes org-wide coverage explicit without renaming the integration package.

Test plan

  • Docs-only change; verify README renders correctly on docs preview
  • Confirm manifest description updates appear in Fleet integration picker

Made with Cursor

Make it explicit that org-level billing data includes Hosted deployments,
Serverless projects, and cloud connected usage—not just legacy ESS deployments.

Co-authored-by: Cursor <cursoragent@cursor.com>
@briannebartlett briannebartlett requested review from a team as code owners July 7, 2026 18:23
Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@github-actions

This comment has been minimized.

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

TL;DR

Check integrations ess_billing failed because packages/ess_billing/docs/README.md is out of sync with the generated README. The PR updates the rendered README, but the source template still renders the previous content.

Remediation

  • Move the README text changes into packages/ess_billing/_dev/build/docs/README.md instead of only editing packages/ess_billing/docs/README.md.
  • Run elastic-package build from packages/ess_billing, then commit the regenerated packages/ess_billing/docs/README.md.
Investigation details

Root Cause

This is a generated documentation drift failure, not an integration runtime failure. Repository documentation states that package docs are written as templates under _dev/build/docs/*.md and processed by elastic-package build into docs/ (docs/extend/documentation-guidelines.md:27-29).

The PR changes packages/ess_billing/docs/README.md directly, including the new “Supported Elastic Cloud products” section and Elastic Cloud wording, but the build regenerated the README from the old template content and found that the committed rendered file no longer matches.

Evidence

--- want
+++ got
@@ -2,18 +2,5 @@
-The Elasticsearch Service Billing integration (also known as the **Elastic Cloud billing integration**) lets you monitor usage and costs for your entire **Elastic Cloud organization**.
-## Supported Elastic Cloud products
-This integration reports **organization-level** billing data.
+The Elasticsearch Service Billing integration allows you to monitor Elasticsearch Service usage and costs.
...
Error: checking package failed: checking readme files are up-to-date failed: files do not match

Verification

Not run locally; the Buildkite log includes the full README drift diff, and the package documentation generation rule identifies _dev/build/docs/README.md as the source file to update.


What is this? | From workflow: PR Buildkite Detective

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

@andrewkroh andrewkroh added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:ess_billing Elasticsearch Service Billing Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels Jul 7, 2026

@3kt 3kt 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.

Couple NIT - good otherwise :)

Comment thread packages/ess_billing/docs/README.md Outdated
Co-authored-by: Alexis Charveriat <alcharveriat@gmail.com>
@briannebartlett

Copy link
Copy Markdown
Contributor Author

Thank you @3kt!

@sholzhauer-es sholzhauer-es 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.

all good from my perspective, good clearifications on doc side 👍

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown

✅ All changelog entries have the correct PR link.

@elastic-vault-github-plugin-prod

Copy link
Copy Markdown

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@infra-vault-gh-plugin-prod

Copy link
Copy Markdown

💚 Build Succeeded

History

@mergify

mergify Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

@shmsr shmsr merged commit 2a35e6a into elastic:main Jul 9, 2026
8 of 11 checks passed
@elastic-vault-github-plugin-prod

Copy link
Copy Markdown

Package ess_billing - 1.9.1 containing this change is available at https://epr.elastic.co/package/ess_billing/1.9.1/

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

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:ess_billing Elasticsearch Service Billing Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants