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

chore: do not set Endpoint and Headers #60

Merged
merged 1 commit into from
Feb 15, 2024
Merged

chore: do not set Endpoint and Headers #60

merged 1 commit into from
Feb 15, 2024

Conversation

rustatian
Copy link
Member

@rustatian rustatian commented Feb 15, 2024

Reason for This PR

closes: roadrunner-server/roadrunner#1848

Description of Changes

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the MIT license.

PR Checklist

[Author TODO: Meet these criteria.]
[Reviewer TODO: Verify that these criteria are met. Request changes if not]

  • All commits in this PR are signed (git commit -s).
  • The reason for this PR is clearly provided (issue no. or explanation).
  • The description of changes is clear and encompassing.
  • Any required documentation changes (code and docs) are included in this PR.
  • Any user-facing changes are mentioned in CHANGELOG.md.
  • All added/changed functionality is tested.

Summary by CodeRabbit

  • Refactor
    • Removed default endpoint setting functionality.
    • Updated logic for setting endpoint and headers in options.
  • Chores
    • Added a deprecation warning for the Jaeger exporter.

Signed-off-by: Valery Piashchynski <piashchynski.valery@gmail.com>
@rustatian rustatian added the enhancement New feature or request label Feb 15, 2024
@rustatian rustatian self-assigned this Feb 15, 2024
Copy link

coderabbitai bot commented Feb 15, 2024

Walkthrough

This update focuses on enhancing configuration flexibility and compatibility within a plugin, specifically by refining how environment variables and configuration files are utilized. The removal of default endpoint settings and the update to how endpoints and headers are managed streamline the configuration process, while the addition of a deprecation warning for the Jaeger exporter signals a shift towards newer standards or tools.

Changes

Files Change Summary
config.go Removed default endpoint setting; Added deprecation warning for Jaeger exporter
plugin.go Updated httpOptions logic: endpoint set if not empty, headers added if present in cfg

Assessment against linked issues

Objective Addressed Explanation
Utilize Opentelemetry specific environment variables for configuration (#1848) It's unclear if the specific environment variables are utilized without seeing the full changes.
Restore use of environment variables as defaults when .rr.yaml is empty (#1848) The summary does not explicitly mention restoring environment variables as defaults.
Implement a mechanism for hardcoded strings only when both configurations are empty (#1848) Details on handling hardcoded strings are not provided in the summary.
Ensure compatibility with Opentelemetry v1.21.1 by testing specific environment variables (#1848) The summary does not address testing with Opentelemetry v1.21.1 or specific variables.
Align with Opentelemetry specifications for configuration handling and defaults (#1848) Without explicit mention of Opentelemetry specifications, it's unclear if this is fully addressed.

Related issues

  • roadrunner-server/roadrunner#1848: This issue's objectives seem partially addressed by the PR, particularly around the use of environment variables and configuration flexibility. However, specific compliance with Opentelemetry v1.21.1 and the handling of hardcoded strings need clarification.

Poem

In fields of code, where logic plays,
A rabbit hopped, through nights and days.
🌟 Tweaking configs, with utmost care,
🚀 To make the plugins, light as air.

"No more defaults," it did decree,
With environment vars, we shall be free.
🐇 Through lines of code, it danced with glee,
A better plugin, for you and me.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@rustatian rustatian marked this pull request as ready for review February 15, 2024 12:05
@rustatian rustatian merged commit 2923880 into master Feb 15, 2024
5 checks passed
@rustatian rustatian deleted the fix/otel-envs branch February 15, 2024 12:05
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4835c8e and 8d98ffe.
Files selected for processing (2)
  • config.go (1 hunks)
  • plugin.go (1 hunks)
Additional comments: 3
config.go (1)
  • 73-78: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [64-64]

The deprecation warning for the Jaeger exporter is appropriate given the context. However, ensure that this warning is also reflected in the documentation and any user guides to prevent confusion.

plugin.go (2)
  • 215-217: The conditional addition of the endpoint to the options slice based on its non-emptiness is a good practice to avoid unnecessary default configurations. This change aligns with the PR's objective to enhance configuration flexibility.
  • 219-221: Similarly, adding headers to the options slice only if the cfg struct contains headers is a logical improvement. It ensures that headers are only set when explicitly configured, enhancing the plugin's configurability.

config.go Show resolved Hide resolved
config.go Show resolved Hide resolved
devnev added a commit to devnev/otel that referenced this pull request Aug 16, 2024
This is applying the change from roadrunner-server#60 to the grpc client.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[💡 FEATURE REQUEST]: Use Opentelemerty specific environment variables
1 participant