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 opentelemetry-demo chart #280

Merged
merged 27 commits into from
Jul 26, 2022
Merged

Conversation

wph95
Copy link
Member

@wph95 wph95 commented Jul 20, 2022

@wph95 wph95 requested review from a team July 20, 2022 05:39
@dmitryax
Copy link
Member

dmitryax commented Jul 20, 2022

Hi @wph95, thanks for the contribution. Couple of initial suggestions/questions:

  • I believe the chart should be called the same name as the repo
  • Looks like prometheus is missing. Is this intentional?

@wph95
Copy link
Member Author

wph95 commented Jul 20, 2022

  • I believe the chart should be called the same name as the repo

done

  • Looks like prometheus is missing. Is this intentional?

Yes, the current version does not include metrics (grafana and prometheus)
I'm a little concerned that PR is too big to review, so metric is not included yet. plan add it in next PR :)

@dmitryax
Copy link
Member

Yes, the current version does not include metrics (grafana and prometheus)
I'm a little concerned that PR is too big to review, so metric is not included yet. plan add it in next PR :)

Sounds good 👍

Copy link
Member

@dineshg13 dineshg13 left a comment

Choose a reason for hiding this comment

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

otel-col is failing for me with error

Error: failed to get config: cannot unmarshal the configuration: error reading top level configuration sections: 1 error(s) decoding:

* '' has invalid keys: config
2022/07/20 17:43:16 collector server run finished with error: failed to get config: cannot unmarshal the configuration: error reading top level configuration sections: 1 error(s) decoding:

* '' has invalid keys: config

This might becoz of bad indentation in exporter section of configmap. I think it would be good idea to yamllint these files.

charts/opentelemetry-demo-webstore/templates/otelcol.yaml Outdated Show resolved Hide resolved
wph95 and others added 4 commits July 20, 2022 12:26
2. rename _deployment.yaml
3. otelcol configmap logic improve, add sha256sum!
@wph95
Copy link
Member Author

wph95 commented Jul 20, 2022

otel-col is failing for me with error

@dineshg13 fixed it :)

@saurabhdes
Copy link

saurabhdes commented Jul 21, 2022

What's the best way to test this PR. I tried below steps after looking at README but ran into below error :
helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts

helm install my-otel-demo open-telemetry/opentelemetry-demo-webstore
Error: INSTALLATION FAILED: failed to download "open-telemetry/opentelemetry-demo-webstore"

The error seems to be happening because the chart for "opentelemetry-demo-webstore" doesn't yet exist in the repo. Any suggestions on how to get workaround this issue so i can test this PR?

helm search repo open-telemetry

NAME CHART VERSION APP VERSION DESCRIPTION
open-telemetry/opentelemetry-collector 0.22.2 0.55.0 OpenTelemetry Collector Helm chart for Kubernetes
open-telemetry/opentelemetry-operator 0.9.4 0.54.0 OpenTelemetry Operator Helm chart for Kubernetes

@TylerHelmuth
Copy link
Member

What's the best way to test this PR.

If you do gh pr checkout 280 you'll be able to checkout this PR. Then you'd be able to do normal helm commands by pointing to ./charts/opentelemetry-demo-webstore. For example, you could do helm template testing ./charts/opentelemetry-demo-webstore --output-dir ./testing to see the files that would be rendered during a default install of the chart.

@saurabhdes
Copy link

saurabhdes commented Jul 21, 2022

What's the best way to test this PR.

If you do gh pr checkout 280 you'll be able to checkout this PR. Then you'd be able to do normal helm commands by pointing to ./charts/opentelemetry-demo-webstore. For example, you could do helm template testing ./charts/opentelemetry-demo-webstore --output-dir ./testing to see the files that would be rendered during a default install of the chart.

thanks @TylerHelmuth ! I was able to deploy the services successfully in my AKS cluster as well as local Mac on kind cluster.

@dineshg13
Copy link
Member

@wph95 what the reason for not including prometheus & grafana ? we do have some metrics & I believe we are working to adding more

@saurabhdes
Copy link

saurabhdes commented Jul 21, 2022

I noticed that in Jaeger "cart-service" is missing in this K8s helm setup and present in docker-compose setup - attaching Jaeger pics for both. I do see the cart-service pod running in both cases with no errors, so likely some instrumentation setup in K8s helm case but not sure.

Screen Shot 2022-07-20 at 10 54 22 PM

Screen Shot 2022-07-21 at 3 52 53 PM

@wph95
Copy link
Member Author

wph95 commented Jul 22, 2022

@wph95 what the reason for not including prometheus & grafana ? we do have some metrics & I believe we are working to adding more

#280 (comment)
wph95#1 (wait this pr merge

change _deployment.yaml to _deployment.tpl
@TylerHelmuth
Copy link
Member

@Allex1 would appreciate your review on this PR.

@JaredTan95
Copy link
Member

@wph95 test meanings examples like https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-collector/examples?
Will it i added in this PR or another separated?

@wph95
Copy link
Member Author

wph95 commented Jul 24, 2022

@wph95 test meanings examples like https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-collector/examples? Will it i added in this PR or another separated?

I think it is better to PR separately

@JaredTan95
Copy link
Member

@wph95 test meanings examples like https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-collector/examples? Will it i added in this PR or another separated?

I think it is better to PR separately

+1

Copy link
Member

@JaredTan95 JaredTan95 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@Allex1 Allex1 left a comment

Choose a reason for hiding this comment

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

@wph95 Some docs or comments in values would be appropriate for new users. We can probably do this in a future docs pr. Great contribution! Thanks!

Copy link
Member

@TylerHelmuth TylerHelmuth left a comment

Choose a reason for hiding this comment

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

@wph95
Copy link
Member Author

wph95 commented Jul 25, 2022

@wph95 wph95 requested review from TylerHelmuth and dmitryax July 25, 2022 18:37
Copy link
Member

@dmitryax dmitryax left a comment

Choose a reason for hiding this comment

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

the chart is still located at /charts/opentelemetry-demo-webstore. Can you please update the directory name?

Comment on lines 4 to 9
██████╗ ████████╗███████╗██╗ ██████╗ ███████╗███╗ ███╗ ██████╗
██╔═══██╗╚══██╔══╝██╔════╝██║ ██╔══██╗██╔════╝████╗ ████║██╔═══██╗
██║ ██║ ██║ █████╗ ██║ ██║ ██║█████╗ ██╔████╔██║██║ ██║
██║ ██║ ██║ ██╔══╝ ██║ ██║ ██║██╔══╝ ██║╚██╔╝██║██║ ██║
╚██████╔╝ ██║ ███████╗███████╗ ██████╔╝███████╗██║ ╚═╝ ██║╚██████╔╝
╚═════╝ ╚═╝ ╚══════╝╚══════╝ ╚═════╝ ╚══════╝╚═╝ ╚═╝ ╚═════╝
Copy link
Member

Choose a reason for hiding this comment

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

Nice :)

Copy link
Member

Choose a reason for hiding this comment

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

It's beautiful!

charts/opentelemetry-demo-webstore/templates/NOTES.txt Outdated Show resolved Hide resolved
Copy link
Member

@dmitryax dmitryax left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @wph95!

Copy link
Member

@TylerHelmuth TylerHelmuth left a comment

Choose a reason for hiding this comment

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

Couple more questions as it had been a while since I look through things in depth.

{{- include "otel.demo.service" $config -}}
{{ end }}

{{- end }}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
{{- end }}
{{- end }}

charts/opentelemetry-demo/templates/services.yaml Outdated Show resolved Hide resolved
charts/opentelemetry-demo/values.schema.json Outdated Show resolved Hide resolved
charts/opentelemetry-demo/values.yaml Show resolved Hide resolved
Copy link
Member

@TylerHelmuth TylerHelmuth left a comment

Choose a reason for hiding this comment

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

Thanks @wph95 and everyone else involved! Excited to see this chart help our end users.

@TylerHelmuth TylerHelmuth merged commit 8fa530f into open-telemetry:main Jul 26, 2022
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