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

[DOC] Clarify endpoint access for consistent hash rings doc #3918

Open
knylander-grafana opened this issue Jul 29, 2024 · 1 comment
Open
Labels
keepalive Label to exempt Issues / PRs from stale workflow type/docs Improvements or additions to documentation

Comments

@knylander-grafana
Copy link
Contributor

knylander-grafana commented Jul 29, 2024

The docs for Tuning the consistent hashrings need to be updated. It is unclear if there are requirements to access the web interfaces endpoint to be accessed.

Question to answer:

  • Are there requirements for each of the interfaces to be available?
    • Distributor - distributor/ring - only available if you the "global" rate limiting option (reference)
    • Ingester - ingester/ring
    • Metrics-generator - metrics-generator/ring
    • compactor - compactor/ring
  • Add the base URL for the API endpoints
  • Add procedure for accessing the endpoints

Doc to update: https://grafana.com/docs/tempo/latest/operations/consistent_hash_ring/#tune-the-consistent-hash-rings

Investigation

I tried testing the API endpoint interfaces by using intro-to-mltp as the environment. The base URL is localhost:3000/api for accessing Grafana.

Access localhost:3000/api/metrics-generator/ring results with an error since /api isn't necessary.

However, the port for the Tempo API is 3200. The /api/ path isn't necessary. Changing the URL to localhost:3200/metrics-generator/ring results with this:
image

Ingester: The localhost:3200/ingester/ring works.

Compactor: localhost:3200/compactor/ring does not work. Maybe there is a configuration option that isn't set for this?

Distributor: localhost:3200/distributor/ring does not work -this might be a configuration setting.

@knylander-grafana knylander-grafana added the type/docs Improvements or additions to documentation label Jul 29, 2024
Copy link
Contributor

This issue has been automatically marked as stale because it has not had any activity in the past 60 days.
The next time this stale check runs, the stale label will be removed if there is new activity. The issue will be closed after 15 days if there is no new activity.
Please apply keepalive label to exempt this Issue.

@github-actions github-actions bot added the stale Used for stale issues / PRs label Sep 28, 2024
@knylander-grafana knylander-grafana added keepalive Label to exempt Issues / PRs from stale workflow and removed stale Used for stale issues / PRs labels Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
keepalive Label to exempt Issues / PRs from stale workflow type/docs Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant