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

Add "features" command to print documentation about all features #11998

Open
yurishkuro opened this issue Dec 30, 2024 · 4 comments
Open

Add "features" command to print documentation about all features #11998

yurishkuro opened this issue Dec 30, 2024 · 4 comments

Comments

@yurishkuro
Copy link
Member

Is your feature request related to a problem? Please describe.

Collector has the concept of feature gates. When running the help command one can see (some?) features in the --feature-gates flag, e.g.

--feature-gates flag Comma-delimited list of feature gate identifiers. Prefix with '-' to disable the feature. '+' or no prefix will enable the feature. (default -connector.spanmetrics.legacyMetricNames,-exporter.UsePullingBasedExporterQueueBatcher,-filter.filterlog.useOTTLBridge,-filter.filtermetric.useOTTLBridge,-filter.filterspan.useOTTLBridge,jaeger.sampling.includeDefaultOpStrategies,pkg.translator.prometheus.NormalizeName,-pkg.translator.prometheus.PermissiveLabelSanitization,-processor.tailsamplingprocessor.metricstatcountspanssampled,receiver.jaeger.DisableRemoteSampling,-service.noopTracerProvider,-service.profilesSupport,telemetry.UseLocalHostAsDefaultMetricsAddress,-telemetry.disableAddressFieldForInternalTelemetry,-telemetry.disableHighCardinalityMetrics,telemetry.useOtelWithSDKConfigurationForInternalTelemetry

This output is quite unreadable and does not expose any metadata about individual features.

Describe the solution you'd like

Create a features command that will print a summary of all features and their metadata. The command can optionally accept a specific feature ID to limit the output to just one feature.

Describe alternatives you've considered

There is a way to see the features via zpages extension http://localhost:55679/debug/featurez, but it's not always enabled and is overall a harder way to get to the same info than a CLI command.

zpages.WriteHTMLFeaturesTable(w, getFeaturesTableData())

@morishima-senpai
Copy link

Hi, I would like to work on this:)

@ADI-ROXX
Copy link

@yurishkuro Can you check the PR once?

@asimchoudhary
Copy link

hi, @yurishkuro is this issue solved ?

@ADI-ROXX
Copy link

@asimchoudhary Almost. You can check the following PR:
jaegertracing/jaeger#6442

github-merge-queue bot pushed a commit that referenced this issue Feb 5, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

- add features command 

<!-- Issue number if applicable -->
#### Link to tracking issue
- #11998

<!--Describe what testing was performed and which tests were added.-->
#### Testing
- test with `make`
- test with `make test`
<!--Describe the documentation added.-->
#### Documentation

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Signed-off-by: danish9039 <danishsiddiqui040@gmail.com>
Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>
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 a pull request may close this issue.

4 participants