Skip to content

Clarify titles and descriptions of various packages of same technology#19526

Open
MichelLosier wants to merge 4 commits into
elastic:mainfrom
MichelLosier:clarify-package-title-and-desc
Open

Clarify titles and descriptions of various packages of same technology#19526
MichelLosier wants to merge 4 commits into
elastic:mainfrom
MichelLosier:clarify-package-title-and-desc

Conversation

@MichelLosier

@MichelLosier MichelLosier commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Proposed commit message

Updates the titles and descriptions of various packages that observe the same technology to clarify their distinction

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

@MichelLosier MichelLosier added the enhancement New feature or request label Jun 15, 2026
@MichelLosier MichelLosier requested review from a team as code owners June 15, 2026 16:43
@github-actions

github-actions Bot commented Jun 15, 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.

@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Jun 15, 2026 •
edited
Loading

Copy link
Copy Markdown

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

jmikell821
jmikell821 reviewed Jun 15, 2026
View reviewed changes

@jmikell821 jmikell821 left a comment

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.

Reviewed all the title/description updates. Everything from my end LGTM!

@andrewkroh andrewkroh added Integration:nginx_otel_input NGINX OpenTelemetry Input Package Integration:prometheus_input Prometheus Input Integration:redis_input_otel Redis OpenTelemetry Input Package Integration:redisenterprise Redis Enterprise Integration:iis IIS Integration:mysql_input_otel MySQL OpenTelemetry Input Package Integration:apache_input_otel Apache HTTP Server OpenTelemetry Input Package Integration:apache Apache HTTP Server Integration:apache_spark Apache Spark Integration:iis_otel_input IIS OpenTelemetry Input Package Integration:docker_input_otel Docker OpenTelemetry Input Package Integration:prometheus Prometheus Integration:mysql_enterprise MySQL Enterprise Integration:nginx Nginx Integration:kafka_connect Kafka Connect Integration:nginx_ingress_controller Nginx Ingress Controller Logs Integration:prometheus_input_otel_raw Prometheus OTel Scrape (Bring Your Own Config) Integration:kafka_input_otel Kafka OpenTelemetry Input Integration:docker Docker labels Jun 15, 2026
@andrewkroh andrewkroh added Integration:redis Redis Integration:prometheus_input_otel Prometheus OTel Scrape (Guided) Integration:kafka Kafka Integration:kafka_log Custom Kafka Logs Integration:apache_tomcat Apache Tomcat Integration:mysql MySQL Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] Team:obs-ds-hosted-services Observability Hosted Services team [elastic/obs-ds-hosted-services] Team:Security-Windows Platform Security Windows Platform team [elastic/sec-windows-platform] Team:Ecosystem Packages Ecosystem team [elastic/ecosystem] labels Jun 15, 2026
@infra-vault-gh-plugin-prod

infra-vault-gh-plugin-prod Bot commented Jun 15, 2026

Copy link
Copy Markdown

Pinging @elastic/sec-windows-platform (Team:Security-Windows Platform)

@infra-vault-gh-plugin-prod

infra-vault-gh-plugin-prod Bot commented Jun 15, 2026

Copy link
Copy Markdown

Pinging @elastic/ecosystem (Team:Ecosystem)

teresaromero
teresaromero reviewed Jun 16, 2026
View reviewed changes

@teresaromero teresaromero left a comment •
edited
Loading

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.

READMES and any other doc that is referencing the title and description should be align with changes. i think the best will be asking claude to go through all the updated integrations and make sure _dev/build/docs/README.md is aligned with the changes and then regenerate docs/README.md with elastic-package build command (this one is generated from the template one)

i was trying to look if the title or description was referenced as a template variable but it appears they are hardcoded.... also keep in mind i see some packages not having the template (_dev/build/docs) but directly the docs/README.md

A quick way to check this is seen correctly is by using the elastic-package tool. When running elastic-package stack up within the root of the integrations repository, the local registry used on the stack includes the local builds of the packages... so for instance, you could elastic-package foearch -- build (this builds all the packages) and then run the stack. When you go to the local kibana you should be able to see the tiles renamed and the package documentation updated. let me know if you have any doubt

EDIT: also, could we wrap up a small skill/rule/X where the style on titles and descriptions are stablished so future itegrations follow the same aproach. i am thinking on referencing an AI agent to review the integration and check for this (as for example we use Vale linting for written style)

@andrewkroh andrewkroh added the documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. label Jun 16, 2026
@MichelLosier

MichelLosier commented Jun 16, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Thanks for the catch there @teresaromero! I've updated the Readmes in 62e33b7

ishleenk17
ishleenk17 reviewed Jun 19, 2026
View reviewed changes
Comment thread packages/iis_input_otel/docs/README.md
@@ -1,7 +1,7 @@
# IIS OpenTelemetry Input Package

@ishleenk17 ishleenk17 Jun 19, 2026

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.

If we are removing the name Input Package here.
Just writing IIS (OpenTelemtry) can mean multiple thing.
Input package
Content Package (Assets)
Integration PAckage (Composable one).
Isn't this ambiguous ?

@MichelLosier MichelLosier Jun 22, 2026

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.

I agree when the Composable package one arrives we'll need again look at how we are providing a choice to the user. In this discussion with the team, it seems we need a git issue to capture how or if it all we want to show input packages that are already composed into a larger integration.

With IIS right now a user has the choice of

  • IIS
  • IIS OpenTelemetry Input Package
  • IIS OpenTelemetry assets

The immediate goal here is to simplify this to a choice of (I want to monitor X with ECS or OTEL) absent a composable package choice:

  • IIS
  • IIS (OpenTelemetry)

With hidden by default filtering:

  • IIS OpenTelemetry assets

When we create the composable package, I think we'll want to keep the choice simple still with:

  • IIS
  • IIS (OpenTelemetry) (composable package)

Again still hidden by default filtering:

  • IIS OpenTelemetry assets

At which point the input package I could see getting a different name again as the composable integration would be the preferred package for OTEL, but also making sure the input package is not an immediate or visible option to complicate that choice.

@MichelLosier MichelLosier Jun 22, 2026 •
edited
Loading

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.

Created a follow up issue: https://github.com/elastic/ingest-dev/issues/8480

Comment thread packages/iis_input_otel/docs/README.md Outdated

## Overview
The IIS OpenTelemetry Input Package for Elastic enables collection of telemetry data from Internet Information Services (IIS) web servers through OpenTelemetry protocols using the [iisreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/iisreceiver#iis-receiver).
This integration enables collection of telemetry data from Internet Information Services (IIS) web servers through OpenTelemetry protocols using the [iisreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/iisreceiver#iis-receiver).

@ishleenk17 ishleenk17 Jun 19, 2026

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.

Is it right to refer to this as integration ?
This is an input package. Integration would be the composable packages that we plan to develop in furture that actually combines the configuration (input packs) and the asstes (contet packs).

@MichelLosier MichelLosier Jun 22, 2026

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.

I think viewing these in the context of the integrations experience, there is a broader use of this term aside from our distinction of package types. I think though it is fine in the Readme here to get into the specifics and use "This input package" or just the title The IIS (OpenTelemetry) package as a convention.

@MichelLosier MichelLosier Jun 22, 2026

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.

Updated in 5431e01

@ishleenk17

ishleenk17 commented Jun 19, 2026

Copy link
Copy Markdown
Member

@MichelLosier : Also what is the overall plan here fro changing the titles and descriptions ?
Are we grouping them based of a key search or something similar ?

@MichelLosier

MichelLosier commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

@ishleenk17 The idea here is to have the title and descriptions communicate what the package does and not bother the user with the underlying implementation detail of it being an input package.

Separately content packages wont be shown by default anymore (https://github.com/elastic/ingest-dev/issues/8097), and their naming will be unchanged.

Issue related to grouping: https://github.com/elastic/ingest-dev/issues/8082

This is a for-now work as we introduce composables and grouping
meta issue: https://github.com/elastic/ingest-dev/issues/8083

@MichelLosier MichelLosier enabled auto-merge (squash) June 19, 2026 14:04
@ishleenk17

ishleenk17 commented Jun 21, 2026

Copy link
Copy Markdown
Member

@ishleenk17 The idea here is to have the title and descriptions communicate what the package does and not bother the user with the underlying implementation detail of it being an input package.

Separately content packages wont be shown by default anymore (elastic/ingest-dev#8097), and their naming will be unchanged.

Issue related to grouping: elastic/ingest-dev#8082

This is a for-now work as we introduce composables and grouping meta issue: elastic/ingest-dev#8083

Ok, sure!
I have some questions above regarding naming. Please see that.

@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Jun 22, 2026

Copy link
Copy Markdown

✅ All changelog entries have the correct PR link.

@elasticmachine

elasticmachine commented Jun 22, 2026

Copy link
Copy Markdown

💚 Build Succeeded

History

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

Reviewers

@ishleenk17 ishleenk17 ishleenk17 left review comments

@MichaelKatsoulis MichaelKatsoulis MichaelKatsoulis approved these changes

@teresaromero teresaromero teresaromero approved these changes

@nfritts nfritts nfritts approved these changes

@jmikell821 jmikell821 jmikell821 approved these changes

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:apache_input_otel Apache HTTP Server OpenTelemetry Input Package Integration:apache_spark Apache Spark Integration:apache_tomcat Apache Tomcat Integration:apache Apache HTTP Server Integration:docker_input_otel Docker OpenTelemetry Input Package Integration:docker Docker Integration:iis_otel_input IIS OpenTelemetry Input Package Integration:iis IIS Integration:kafka_connect Kafka Connect Integration:kafka_input_otel Kafka OpenTelemetry Input Integration:kafka_log Custom Kafka Logs Integration:kafka Kafka Integration:mysql_enterprise MySQL Enterprise Integration:mysql_input_otel MySQL OpenTelemetry Input Package Integration:mysql MySQL Integration:nginx_ingress_controller Nginx Ingress Controller Logs Integration:nginx_otel_input NGINX OpenTelemetry Input Package Integration:nginx Nginx Integration:prometheus_input_otel_raw Prometheus OTel Scrape (Bring Your Own Config) Integration:prometheus_input_otel Prometheus OTel Scrape (Guided) Integration:prometheus_input Prometheus Input Integration:prometheus Prometheus Integration:redis_input_otel Redis OpenTelemetry Input Package Integration:redis Redis Integration:redisenterprise Redis Enterprise Team:Ecosystem Packages Ecosystem team [elastic/ecosystem] Team:obs-ds-hosted-services Observability Hosted Services team [elastic/obs-ds-hosted-services] Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] Team:Security-Windows Platform Security Windows Platform team [elastic/sec-windows-platform]

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@MichelLosier @ishleenk17 @elasticmachine @MichaelKatsoulis @teresaromero @nfritts @jmikell821 @andrewkroh