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

Rename built-in ExemplarFilters #2919

Merged
merged 13 commits into from
Dec 20, 2022

Conversation

cijothomas
Copy link
Member

@cijothomas cijothomas commented Nov 4, 2022

Renames the built-in ExemplarFilters to AlwaysOn, AlwaysOff, TraceBased. (inspired from the built-in samplers in trace spec)

Minor clarification about ExemplarFilters, that they only make measurements eligible for being Exemplars.

Fix links:
Currently, the set of built-in ExemplarFilters are not documented in the SDK page, but user is taken to a link, which takes to yet another link, which lists the available ExemplarFilters. This PR adds the built-in filter details in the SDK page itself, instead of only being documented in the environment variable page.

@cijothomas
Copy link
Member Author

@jsuereth PTAL. Thanks.!

specification/metrics/sdk.md Outdated Show resolved Hide resolved
@cijothomas cijothomas changed the title Editorial/Minor clarification for ExemplarFilter Rename built-in ExemplarFilters Nov 10, 2022
Copy link
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

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

LGTM with a changelog entry.

Copy link
Contributor

@jsuereth jsuereth left a comment

Choose a reason for hiding this comment

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

I'm ok aiming for consistency, but two questions raised -

  1. Will this be confusing to users
  2. Should we be doing renames during feature-freeze? This causes churn / could break an SDK that has the feature implemented. Just want to check impact before making that change.

specification/sdk-environment-variables.md Show resolved Hide resolved
specification/metrics/sdk.md Outdated Show resolved Hide resolved
Copy link
Member

@jack-berg jack-berg left a comment

Choose a reason for hiding this comment

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

I like the suggest to rename SampledWithTrace to TraceBased for consistency

specification/metrics/sdk.md Outdated Show resolved Hide resolved
@github-actions
Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Nov 29, 2022
@github-actions
Copy link

github-actions bot commented Dec 7, 2022

Closed as inactive. Feel free to reopen if this PR is still being worked on.

@github-actions github-actions bot closed this Dec 7, 2022
@carlosalberto carlosalberto reopened this Dec 8, 2022
@carlosalberto
Copy link
Contributor

Reopening as it seems this was briefly forgotten, but has enough approvals to be merged. @cijothomas please consider addressing the latest bits so we can merge this ;)

@github-actions github-actions bot removed the Stale label Dec 9, 2022
@cijothomas
Copy link
Member Author

@reyang @jack-berg @jsuereth Please do a final check. "TraceBased" suggestion is done, and also added changelog.

@cijothomas
Copy link
Member Author

Reopening as it seems this was briefly forgotten, but has enough approvals to be merged. @cijothomas please consider addressing the latest bits so we can merge this ;)

Done!

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.

8 participants