tempo icon indicating copy to clipboard operation
tempo copied to clipboard

[DOC] Adding missing `metric-generator` keys

Open WesselAtWork opened this issue 9 months ago • 7 comments

What this PR does:

Adds missing keys to the metrics-generator

Which issue(s) this PR fixes: Fixes #3642

Sources/References

override_ring_key


https://github.com/grafana/tempo/blob/251bf5a9a74fd586ffd3dedcc2c8000f36aa9a78/modules/generator/config.go#L49

override_ring_key


https://github.com/grafana/tempo/blob/251bf5a9a74fd586ffd3dedcc2c8000f36aa9a78/modules/generator/config.go#L50 https://github.com/grafana/tempo/blob/251bf5a9a74fd586ffd3dedcc2c8000f36aa9a78/modules/generator/config.go#L18-L19

processor.service_graphs.peer_attributes

https://github.com/grafana/tempo/blob/251bf5a9a74fd586ffd3dedcc2c8000f36aa9a78/modules/generator/processor/servicegraphs/config.go#L54-L57 https://github.com/grafana/tempo/blob/251bf5a9a74fd586ffd3dedcc2c8000f36aa9a78/modules/generator/processor/servicegraphs/servicegraphs.go#L57-L59

~processor.span_metrics.subprocessors~

This one did not work https://github.com/grafana/tempo/blob/251bf5a9a74fd586ffd3dedcc2c8000f36aa9a78/modules/generator/processor/spanmetrics/config.go#L59-L62

storage.trace.pool

https://github.com/grafana/tempo/blob/854cacaa422da5a9ff0b0584528cc04119309f22/tempodb/pool/config.go#L11-L12

WesselAtWork avatar May 02 '24 11:05 WesselAtWork

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar May 02 '24 11:05 CLAassistant

Unsure if I should put the WAL config in it's own block. The loki docs usually separate out common config into typed blocks e.g. https://grafana.com/docs/loki/latest/configure/#s3_storage_config

They postfix these blocks with _config

WesselAtWork avatar May 02 '24 12:05 WesselAtWork

Just discovered something: missing the localblocks key https://github.com/grafana/tempo/blob/251bf5a9a74fd586ffd3dedcc2c8000f36aa9a78/modules/generator/config.go#L53-L57

and most of the ring keys: https://github.com/grafana/tempo/blob/251bf5a9a74fd586ffd3dedcc2c8000f36aa9a78/modules/generator/generator_ring.go#L18-L31

WesselAtWork avatar May 02 '24 13:05 WesselAtWork

Howdy, @WesselAtWork. Appreciate all the details cleaned up here!

@kvrhdn is going to take a look at this in the next few days. Just didn't want you to think we were ignoring you.

joe-elliott avatar May 02 '24 20:05 joe-elliott

I love all the clean up you've done on this doc. It really helps readability. (I'll defer to developer review for this PR.)

knylander-grafana avatar May 20 '24 21:05 knylander-grafana

Should I pull master?

Seems it broke on the linting step

WesselAtWork avatar Jun 25 '24 10:06 WesselAtWork

Try rebasing on main and let's see what CI says. make lint base=main locally should give some information as well.

zalegrala avatar Jun 25 '24 18:06 zalegrala

This PR must be merged before a backport PR will be created.

github-actions[bot] avatar Jul 23 '24 18:07 github-actions[bot]

The backport to release-v2.5 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-3643-to-release-v2.5 origin/release-v2.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 9951e7c4a9278f57410eb458694f1c52c0182d78

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-3643-to-release-v2.5
# Create the PR body template
PR_BODY=$(gh pr view 3643 --json body --template 'Backport 9951e7c4a9278f57410eb458694f1c52c0182d78 from #3643{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release-v2.5] [DOC] Adding missing `metric-generator` keys' --body-file - --label 'type/docs' --label 'backport' --base release-v2.5 --milestone release-v2.5 --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-3643-to-release-v2.5

# Create a pull request where the `base` branch is `release-v2.5` and the `compare`/`head` branch is `backport-3643-to-release-v2.5`.

# Remove the local backport branch
git switch main
git branch -D backport-3643-to-release-v2.5

github-actions[bot] avatar Jul 23 '24 18:07 github-actions[bot]

Not backporting these changes. There have been too many changes to the configuration/_index.md file. These changes will go live with the next release.

knylander-grafana avatar Jul 23 '24 18:07 knylander-grafana