celestiaorg / orchestrator-relayer

Go implementation of the Blobstream orchestrator and relayer
Apache License 2.0
29 stars 17 forks source link

feat: add metrics to orchestrator and relayer #674

Closed rach-id closed 8 months ago

rach-id commented 8 months ago

Overview

Adds metrics to orchestrator and relayer

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 8 months ago

Walkthrough

The changes indicate the integration of telemetry and metrics collection functionality across various components of the blobstream service. The focus is on enabling and configuring OpenTelemetry Protocol (OTLP) metrics with an HTTP exporter, incorporating Prometheus for monitoring, and adjusting function calls and configurations to support these enhancements. The modifications suggest a concerted effort to improve observability within the service's infrastructure.

Changes

Files Change Summary
cmd/blobstream/base/config.go Added flags/functions for OTLP metrics with HTTP exporter.
cmd/blobstream/bootstrapper/cmd.go
p2p/host_test.go
Modified CreateHost function calls to include an additional nil argument.
cmd/blobstream/common/helpers.go
cmd/blobstream/relayer/cmd.go
p2p/host.go
Added prometheus import and registerer parameter to functions.
cmd/blobstream/orchestrator/...
cmd/blobstream/relayer/...
orchestrator/orchestrator.go
relayer/relayer.go
telemetry/metrics.go
testing/blobstream.go
Integrated telemetry and metrics, added related configurations and initialization.
e2e/scripts/... Added --metrics and --metrics.endpoint flags with comments.

🐇✨ To metrics and beyond, we hop and we leap, With Prometheus's gaze, our performance we keep. Through the streams of the blobs, our telemetry flows, In a burrow of data, our observability grows. 🌟📊

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - You can directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging `@coderabbitai` in a comment. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - You can tag `@coderabbitai` in a PR comment and ask questions about the PR and the codebase. 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.` - `@coderabbitai read the files in the src/scheduler package and generate 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. ### 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](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
codecov-commenter commented 8 months ago

Codecov Report

Attention: 17 lines in your changes are missing coverage. Please review.

Comparison is base (922d0e5) 24.56% compared to head (871c278) 24.38%.

Files Patch % Lines
orchestrator/orchestrator.go 0.00% 7 Missing :warning:
relayer/relayer.go 0.00% 7 Missing :warning:
p2p/host.go 62.50% 1 Missing and 2 partials :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #674 +/- ## ========================================== - Coverage 24.56% 24.38% -0.18% ========================================== Files 29 29 Lines 3212 3227 +15 ========================================== - Hits 789 787 -2 - Misses 2328 2343 +15 - Partials 95 97 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.