Skip to content
New issue

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

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

Already on GitHub? # to your account

Move otel-collector-metrics to k8s-infra chart #593

Open
grandwizard28 opened this issue Jan 6, 2025 · 0 comments
Open

Move otel-collector-metrics to k8s-infra chart #593

grandwizard28 opened this issue Jan 6, 2025 · 0 comments
Labels
breaking change Changes that break backward compatibility chart:k8s-infra Issue related to k8s-infra helm chart chart:signoz Issue related to signoz helm chart

Comments

@grandwizard28
Copy link
Contributor

grandwizard28 commented Jan 6, 2025

Background

There has been some confusion in the community regarding the role and placement of the otel-collector-metrics component. This discussion aims to address these concerns and propose a more logical organization of our collector components.

Current Issues

User Confusion

Recent feedback indicates that users are misunderstanding the purpose of otel-collector-metrics:

  • In #147, a user expected that disabling k8s-infra would disable all collection functionality
  • A Medium article incorrectly suggested that otelCollectorMetrics is responsible for general metrics ingestion
  • In #445, a user is overriding otel-deployment of k8s-infra to enable prometheus collection
  • If a user has more than 1 k8s cluster, the user would want to install SigNoz in one cluster and install k8s-infra in all clusters. With the current setup, it becomes impossible for the user to do prometheus-based scraping in clusters which do not have the SigNoz chart.

Architectural Misalignment

The current placement of otel-collector-metrics in the main SigNoz chart doesn't align with our architectural principles:

  • The component's primary function is scraping Prometheus endpoints from pods with the signoz.io/scrape annotation
  • This is fundamentally a cluster telemetry collection function, which aligns more with the k8s-infra chart's responsibilities
  • The main SigNoz chart should focus on deploying SigNoz's core functionality, while k8s-infra handles collection

Proposed Solution

Component Migration

Move the otel-collector-metrics functionality to the otel-deployment component in the k8s-infra chart. otel-deployment already handles cluster-wide telemetry (such as k8sevents, k8sclustermetrics) and it makes sense to have it handle cluster-wide metric prometheus telemetry as well.

Security Posture

Consolidating privileged collection operations under otel-deployment reduces the number of components requiring elevated cluster access which improves the overall security posture

@grandwizard28 grandwizard28 changed the title Moving otel-collector-metrics to k8s-infra chart Move otel-collector-metrics to k8s-infra chart Jan 6, 2025
@grandwizard28 grandwizard28 added chart:k8s-infra Issue related to k8s-infra helm chart chart:signoz Issue related to signoz helm chart enhancement New feature or request breaking change Changes that break backward compatibility and removed enhancement New feature or request labels Jan 6, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
breaking change Changes that break backward compatibility chart:k8s-infra Issue related to k8s-infra helm chart chart:signoz Issue related to signoz helm chart
Projects
None yet
Development

No branches or pull requests

1 participant