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

Reorganize docker-compose examples into subfolders #740

Merged
merged 3 commits into from
Jun 7, 2021

Conversation

yvrhdn
Copy link
Member

@yvrhdn yvrhdn commented Jun 4, 2021

What this PR does:
Split all docker-compose examples into separate subfolders. I've also updated examples and made them more consistent with each other.

Browse through the new structure here: https://github.com/kvrhdn/tempo/tree/731-split-examples/example/docker-compose

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

TODO

  • Update links in docs/

@yvrhdn yvrhdn changed the title Reorganize docker-compose examples into subfolders Reorganize docker-compose examples into subfolders (Work in progress) Jun 4, 2021
@mdisibio
Copy link
Contributor

mdisibio commented Jun 6, 2021

This is looking really good so far, will keep reviewing. Agree with mounting the grafana-datasources.yaml file instead of the folder, seems simpler to me.

I think some (all?) of the examples are missing the dashboards now. Any example that runs tempo/prometheus/grafana should have the tempo dashboards mounted too.

One more thing: this isn't related to the changes in this PR, but I would like to reconsider the order of examples described in the readme. The first example in the list is the Loki example, but I'm not sure that is the best for new users. The local-storage example is probably the simplest and ideal to list first.

@yvrhdn
Copy link
Member Author

yvrhdn commented Jun 7, 2021

I think some (all?) of the examples are missing the dashboards now. Any example that runs tempo/prometheus/grafana should have the tempo dashboards mounted too.

Yeah, I dropped all the dashboards because they didn't work. Looking into why a bit more: all graphs have labels using $cluster and $namespace but these are never set in our example -> no series are returned.

Screenshot 2021-06-06 at 18 03 08

I've figured out how to add default labels using static_configs in prometheus.yaml. But this doesn't work for the job filter (i.e. job=~"($namespace)/querier").

So I guess the underlying issue is that the dashboards are not made to work with single binary deployments. The different graphs expect labels per specific service.

One more thing: this isn't related to the changes in this PR, but I would like to reconsider the order of examples described in the readme. The first example in the list is the Loki example, but I'm not sure that is the best for new users. The local-storage example is probably the simplest and ideal to list first.

I agree. Local is kind of the default example but it gets lost in the list of storage options. I'll try to highlight this example.

@yvrhdn yvrhdn force-pushed the 731-split-examples branch from 101fd77 to e071863 Compare June 7, 2021 09:48
@yvrhdn yvrhdn marked this pull request as ready for review June 7, 2021 10:07
Copy link
Member

@mapno mapno left a comment

Choose a reason for hiding this comment

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

Overall I really like the changes, great work!

It's a shame we can't use the dashboards because it won't work with single binary deployments. I wonder if we could craft a compatible version with jsonnet.

@joe-elliott
Copy link
Member

It's a shame we can't use the dashboards because it won't work with single binary deployments. I wonder if we could craft a compatible version with jsonnet.

Cortex does this:
https://github.com/grafana/cortex-jsonnet/blob/main/cortex-mixin/config.libsonnet#L24

I don't think we should worry about fixing that as part of this PR though.

@yvrhdn
Copy link
Member Author

yvrhdn commented Jun 7, 2021

I'll create an issue to keep track of the dashboards 👍

@yvrhdn yvrhdn changed the title Reorganize docker-compose examples into subfolders (Work in progress) Reorganize docker-compose examples into subfolders Jun 7, 2021
@joe-elliott
Copy link
Member

The first example in the list is the Loki example, but I'm not sure that is the best for new users. The local-storage example is probably the simplest and ideal to list first.

I did this on purpose b/c it should drive people to the "most complete" example so they can see how to use Loki to create links into Tempo. All of the other examples require copy/pasting trace ids and i didn't want people to think that was required to use Tempo.

@joe-elliott joe-elliott merged commit e2ca336 into grafana:main Jun 7, 2021
@yvrhdn yvrhdn deleted the 731-split-examples branch June 7, 2021 15:59
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.

Docker-compose examples cleanup
4 participants