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

feat: added setup for production observability (metrics via OTEL) #1924

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

sheensantoscapadngan
Copy link
Member

@sheensantoscapadngan sheensantoscapadngan commented Jun 5, 2024

Description 📣

This PR adds setup for prod observability with the following components:

  • Open Telemetry (for instrumentation and gathering of application traces and metrics)
  • Open Telemetry collector (for batching of telemetry data from application servers and for exposing data for long-term storage)
  • Prometheus (for storage of metrics in time-series format)
  • Grafana (for visualization of time-series data from Prometheus)

Type ✨

  • Bug fix
  • New feature
  • Breaking change
  • Documentation

Tests 🛠️

# Here's some code block to paste some code snippets

@sheensantoscapadngan sheensantoscapadngan changed the title [WIP] misc: initial working setup for metrics observabilit [WIP] misc: initial working setup for metrics observability Jun 5, 2024
@sheensantoscapadngan sheensantoscapadngan marked this pull request as ready for review June 5, 2024 14:59
Copy link

gitguardian bot commented Jun 5, 2024

⚠️ GitGuardian has uncovered 3 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
9387833 Triggered Generic Password 33b49f4 docker-compose.dev.observable.yml View secret
9387833 Triggered Generic Password 33b49f4 docker-compose.dev.observable.yml View secret
9387833 Triggered Generic Password fc3a409 prometheus.yml View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

@sheensantoscapadngan sheensantoscapadngan changed the title [WIP] misc: initial working setup for metrics observability feat: added setup for production observability (metrics via OTEL) Jun 5, 2024
.env.example Show resolved Hide resolved

export const apiMetrics = fp(async (fastify) => {
const apiMeter = opentelemetry.metrics.getMeter("API");
const latencyHistogram = apiMeter.createHistogram("API latency", {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Curious: what is the impact of such metric collection on the API? Does it increase our API response times much?

backend/src/main.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@maidul98 maidul98 left a comment

Choose a reason for hiding this comment

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

Good setup, left some questions and comments

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.

2 participants