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: (ART-10521) add local otel collector #166

Merged
merged 2 commits into from
Dec 4, 2024

Conversation

jadzlnds
Copy link

@jadzlnds jadzlnds commented Dec 3, 2024

🚀 Pull Request Checklist

  • Title:

    • [ ] A brief, descriptive title for the changes.
  • Description:

    • [ ] Provide a clear and concise description of your pull request, including the purpose of the changes and the approach you've taken.
  • Context:

    • [ ] Why are these changes necessary? What problem do they solve? Link any related issues.
  • Changes:

    • [ ] List the major changes you've made, ideally organized by commit or feature.
  • Testing:

    • [ ] Describe how the changes have been tested. Include any relevant details about the testing environment and the test cases.
  • Screenshots (if applicable):

    • [ ] If your changes are visual, include screenshots to help explain your changes.
  • Additional Information:

    • [ ] Add any other information that might be useful for reviewers, such as considerations, discussions, or dependencies.
  • Checklist:

    • [ ] I have checked that my code adheres to the project's style guidelines and that my code is well-commented.
    • [ ] I have performed self-review of my own code and corrected any misspellings.
    • [ ] I have made corresponding changes to the documentation (if applicable).
    • [ ] My changes generate no new warnings or errors.
    • [ ] I have added tests that prove my fix is effective or that my feature works.
    • [ ] New and existing unit tests pass locally with my changes.

Summary by Sourcery

Add a local OpenTelemetry collector and Jaeger service to the Docker Compose setup to enhance telemetry and tracing capabilities. Configure the OTel collector with a new YAML file to manage data flow.

New Features:

  • Introduce a local OpenTelemetry (OTel) collector service in the Docker Compose setup to facilitate telemetry data collection.

Enhancements:

  • Add a Jaeger service to the Docker Compose setup for tracing and monitoring purposes.

Deployment:

  • Configure the OTel collector with a new YAML configuration file to define receivers, processors, and exporters for telemetry data.

Copy link

sourcery-ai bot commented Dec 3, 2024

Reviewer's Guide by Sourcery

This PR adds OpenTelemetry (OTEL) collector and Jaeger services to the local development environment. The implementation involves configuring Docker services and setting up the OTEL collector to receive and forward telemetry data to Jaeger.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added OpenTelemetry collector service configuration
  • Configured OTLP receivers for both gRPC (4317) and HTTP (4318) protocols
  • Set up health check extension
  • Configured OTLP exporter to forward data to Jaeger
  • Defined pipelines for traces and metrics
infra/config/otel-collector-config.yaml
Updated Docker Compose configuration to include telemetry services
  • Added OTEL collector service using the official contrib image
  • Added Jaeger all-in-one service for trace visualization
  • Configured necessary port mappings for OTLP and Jaeger UI
  • Set up volume mount for OTEL collector configuration
infra/docker-compose.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @jadzlnds - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please fill out the PR template sections to provide context about the changes, testing performed, and any other relevant information.
  • Consider using specific versions instead of 'latest' tags for the Docker images to ensure reproducible deployments and avoid unexpected changes.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@brunopacheco1 brunopacheco1 merged commit b2c4c32 into main Dec 4, 2024
4 checks passed
@brunopacheco1 brunopacheco1 deleted the chore/add-otel-collector-locally branch December 4, 2024 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants