Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fixed the kubernetes instructions #6191

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

Calm-Rock
Copy link
Member

@Calm-Rock Calm-Rock commented Oct 15, 2024

Summary

Fixes the endpoint in Kubernetes environment instructions

Related Issues / PR's

#6192


Important

Updates Kubernetes instructions to use $(Otel-agent-IP) instead of localhost for endpoints in multiple language-specific documentation files.

  • Behavior:
    • Updates Kubernetes instructions to replace localhost with $(Otel-agent-IP) in endpoint configurations across multiple language-specific documentation files.
    • Adds a note with a link to documentation for obtaining Otel-agent-IP in each file.
  • Files Affected:
    • dotnet-kubernetes-instrumentApplication.md: Changes endpoint in Program.cs example.
    • elixir-kubernetes-instrumentApplication.md: Updates endpoint in runtime.exs configuration.
    • golang-kubernetes-runApplication.md: Modifies endpoint in Go run command.
    • ... and 10 other files for various languages including JavaScript, PHP, Python, Ruby, Rust, and Swift.

This description was created by Ellipsis for 2daab46. It will automatically update as commits are pushed.

Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

@github-actions github-actions bot added the bug Something isn't working label Oct 15, 2024
Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 2daab46 in 38 seconds

More details
  • Looked at 299 lines of code in 14 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. frontend/src/container/OnboardingContainer/Modules/APM/Dotnet/md-docs/Kubernetes/dotnet-kubernetes-instrumentApplication.md:47
  • Draft comment:
    Ensure that the placeholder $(Otel-agent-IP) is correctly formatted for the specific context. For example, in shell scripts, use $Otel_agent_IP without parentheses. This issue is present in multiple files.
  • Reason this comment was not posted:
    Comment did not seem useful.
2. frontend/src/container/OnboardingContainer/Modules/APM/Dotnet/md-docs/Kubernetes/dotnet-kubernetes-instrumentApplication.md:47
  • Draft comment:
    Avoid hardcoding IP addresses directly in the code. Consider using a configuration file or environment variable to manage the Otel-agent-IP for better maintainability and consistency. This comment applies to similar instances in other documentation files as well.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable:
    The diff shows a change from a hardcoded IP address to a placeholder, which suggests that the author is already moving towards a more flexible solution. The comment might be redundant since the change aligns with the suggestion. However, the placeholder still implies a hardcoded value unless it's replaced by a configuration mechanism.
    The placeholder '$(Otel-agent-IP)' might still be considered a form of hardcoding if not properly managed through configuration. The comment could be relevant if the placeholder isn't linked to a configuration system.
    The comment is relevant if the placeholder is not connected to a configuration system, as it still represents a hardcoded value in the code.
    The comment is relevant because the placeholder '$(Otel-agent-IP)' might still be a hardcoded value if not managed through configuration.

Workflow ID: wflow_lnTCXRp1PbPEOmfu


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@prashant-shahi
Copy link
Member

prashant-shahi commented Oct 16, 2024

Can you use only .AddOtlpExporter() and rely on the environment variable OTEL_EXPORTER_OTLP_ENDPOINT for the Otel endpoint? (this goes as per the k8s-infra guide's send data section)

Also, use the http prefix as the insecure flag is applied based on this.

Ref: https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md#environment-variables

@prashant-shahi
Copy link
Member

prashant-shahi commented Oct 16, 2024

Please test and verify these instructions.

Data Flow:

Instrumented Application in K8s => K8s-Infra (Otel-Agent) => SigNoz OSS/Cloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working onboarding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants