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

Documentation feedback: /docs/sources/tempo/configuration/_index.md - Cache allowed roles is missing options #3801

Closed
jordanbertasso opened this issue Jun 21, 2024 · 3 comments
Assignees
Labels
type/docs Improvements or additions to documentation

Comments

@jordanbertasso
Copy link

jordanbertasso commented Jun 21, 2024

The allowed roles listed in the cache documentation differ from the actual allowed roles

image (28)

tempo/pkg/cache/cache.go

Lines 11 to 21 in efb11ea

const (
// individual roles
RoleNone Role = "none"
RoleBloom Role = "bloom"
RoleTraceIDIdx Role = "trace-id-index"
RoleParquetFooter Role = "parquet-footer"
RoleParquetColumnIdx Role = "parquet-column-idx"
RoleParquetOffsetIdx Role = "parquet-offset-idx"
RoleFrontendSearch Role = "frontend-search"
RoleParquetPage Role = "parquet-page"
)

@joe-elliott
Copy link
Member

parquet-column-idx and parquet-offset-idx are supposed to be undocumented. I didn't realize they were in the example.

These cache keys currently do nothing, b/c we don't use offset and column indexes in Parquet atm. We should remove them from the example.

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

I'll remove them from the documentation.

@knylander-grafana
Copy link
Contributor

PR #3826

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
Status: Done
Development

No branches or pull requests

3 participants