Skip to content

Conversation

@sumoanema
Copy link
Collaborator

@sumoanema sumoanema commented Jun 4, 2025

Purpose of this pull request

Adding a note for 12 opentelemetry app docs, after deprecation of env variable syntax in opentelemetry collector syntax

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

… variable syntax in opentelemetry collector syntax
@cla-bot cla-bot bot added the cla-signed Contributor approved, listed in .clabot file label Jun 4, 2025
@sumoanema sumoanema marked this pull request as ready for review June 4, 2025 08:29
Copy link
Collaborator

@kimsauce kimsauce left a comment

Choose a reason for hiding this comment

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

Hi @sumoanema , many thanks for your PR! I converted your note into a reusable reference, and then insert it in each doc. Does this look OK?

@sumoanema
Copy link
Collaborator Author

@kimsauce - So there are certain apps for which username and password are optional, these apps are JMX, activeMQ, cassandra, apache tomcat .
Only in case do we want the note to have the starting as :
"If you're using a username and password with OpenTelemetry Collector"

for the rest it should be :
"For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as :
${environment_variable}"

What do you suggest, how should we make changes for it ?

@kimsauce kimsauce changed the title Adding a note for 12 opentelemetry app docs, after deprecation of env… Add env var syntax deprecation note to 12 OpenTelemetry app docs Jun 6, 2025
@kimsauce
Copy link
Collaborator

kimsauce commented Jun 6, 2025

@kimsauce - So there are certain apps for which username and password are optional, these apps are JMX, activeMQ, cassandra, apache tomcat . Only in case do we want the note to have the starting as : "If you're using a username and password with OpenTelemetry Collector"

for the rest it should be : "For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : ${environment_variable}"

What do you suggest, how should we make changes for it ?

Hi @sumoanema , thank you for clarifying! Ok, I've created two separate reusable versions of the note (required and optional). And put the optional note in JMX, Cassandra, ActiveMQ, Apache Tomcat. The rest have the required version. Can you take a look?

@sumoanema
Copy link
Collaborator Author

Looks good to me @kimsauce

@sumoanema sumoanema requested a review from kimsauce June 6, 2025 02:42
@kimsauce
Copy link
Collaborator

kimsauce commented Jun 6, 2025

Looks good to me @kimsauce

OK! just approved

@sumoanema sumoanema added this pull request to the merge queue Jun 6, 2025
Copy link
Collaborator

@JV0812 JV0812 left a comment

Choose a reason for hiding this comment

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

LGTM

Merged via the queue into main with commit 4d48e8a Jun 6, 2025
7 checks passed
@sumoanema sumoanema deleted the otelenvvarsyntaxnote branch June 6, 2025 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants