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 docs for KubeletTracing feature gate 1.25 #35137

Merged
merged 2 commits into from
Aug 16, 2022

Conversation

sallyom
Copy link
Contributor

@sallyom sallyom commented Jul 18, 2022

Add KubeletTracing Alpha 1.25

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 18, 2022
@netlify
Copy link

netlify bot commented Jul 18, 2022

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name Link
🔨 Latest commit 221d4e8
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/62fbf4849e96c3000834d1ff

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Jul 18, 2022
@k8s-ci-robot k8s-ci-robot requested a review from sftim July 18, 2022 20:15
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jul 18, 2022
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. area/blog Issues or PRs related to the Kubernetes Blog subproject area/release-eng Issues or PRs related to the Release Engineering subproject language/de Issues or PRs related to German language language/es Issues or PRs related to Spanish language language/fr Issues or PRs related to French language language/id Issues or PRs related to Indonesian language language/ja Issues or PRs related to Japanese language language/ko Issues or PRs related to Korean language language/vi Issues or PRs related to Vietnamese language language/zh Issues or PRs related to Chinese language sig/release Categorizes an issue or PR as relevant to SIG Release. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 18, 2022
@sallyom sallyom force-pushed the kubelet-tracing-1-25 branch 2 times, most recently from d3ec751 to e7e76f4 Compare July 18, 2022 20:18
@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 18, 2022
@sallyom
Copy link
Contributor Author

sallyom commented Jul 18, 2022

Issue
KEP
PR

@jihoon-seo
Copy link
Member

/remove-area blog release-eng
/remove-language de es fr id ja ko vi zh
/remove-sig release

Comment on lines 12 to 13
{{< feature-state for_k8s_version="v1.22, kube-apiserver" state="alpha" >}}
{{< feature-state for_k8s_version="v1.25, kubelet" state="alpha" >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm afraid that this use isn't idiomatic. The version should always be just a version string.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wasn't sure how to list each separately, I know. I tried a few different ways. Do you have a suggestion? Or, should I only list the latest? or the earliest? There will be other components added here, too (scheduler next, maybe?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated, added new feature state shortcode under kubelet traces

To enable tracing, enable the `KubeletTracing`
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
on the kubelet. Also, provide the kubelet with a
[tracing configuration](https://github.com/kubernetes/component-base/blob/master/tracing/api/v1/types.go).
Copy link
Contributor

Choose a reason for hiding this comment

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

Watch out for referencing the master branch. Can we reference the v1.25 release branch instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

Comment on lines 981 to 983
OpenTelemetry trace spans. Sampling rate and collector address are configurable. When enabled without
a tracing configuration, a parent span's sampling decision is respected and the default collector
address of 0.0.0.0:4317 is set.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please move:

Sampling rate and collector address are configurable. When enabled without
a tracing configuration, a parent span's sampling decision is respected and the default collector
address of 0.0.0.0:4317 is set.

into the concept docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

@sallyom sallyom force-pushed the kubelet-tracing-1-25 branch 2 times, most recently from eb6c5cc to a85b183 Compare August 11, 2022 18:03
@jihoon-seo
Copy link
Member

/remove-area blog release-eng
/remove-sig release

@k8s-ci-robot k8s-ci-robot removed area/blog Issues or PRs related to the Kubernetes Blog subproject area/release-eng Issues or PRs related to the Release Engineering subproject sig/release Categorizes an issue or PR as relevant to SIG Release. labels Aug 12, 2022
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Docs LGTM. This will need a new tech review - eg from @dashpole.

Some nits.

@sallyom
Copy link
Contributor Author

sallyom commented Aug 13, 2022

Docs LGTM. This will need a new tech review - eg from @dashpole.

Some nits.

committed all suggestions, ty

@sftim
Copy link
Contributor

sftim commented Aug 14, 2022

LGTM (for SIG Docs) including latest updates.


The kubelet CRI interface and authenticated http servers are instrumented to generate
trace spans. As with the apiserver, the endpoint and sampling rate are configurable.
Trace context propagation is also configured. When enabled without a tracing configuration sampling rate,
Copy link
Contributor

Choose a reason for hiding this comment

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

For the sampling rate, the parent span's sampling decision is always respected first (i.e. always sample if parent is sampled, never sample if parent is not sampled). The configured sampling rate applies to spans without a parent.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated, it now reads:

A parent span's sampling decision is always respected.
A provided tracing configuration sampling rate will apply to spans without a parent.
Enabled without a configured endpoint, the default OpenTelemetry Collector reciever address of "localhost:4317" is set.

Copy link
Contributor

Choose a reason for hiding this comment

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

That works for me!

@dashpole
Copy link
Contributor

LGTM for Sig-Instrumentation

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 16, 2022
@reylejano
Copy link
Member

@sallyom please rebase

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 16, 2022
@sallyom
Copy link
Contributor Author

sallyom commented Aug 16, 2022

rebased! ty for the reviews!

@reylejano
Copy link
Member

Applying lgtm from SIG Instrumentation in this comment
/lgtm

/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 16, 2022
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 1fed1357b919329bd54ba9d9e676839b1a63e9ad

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dashpole, reylejano

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 16, 2022
@k8s-ci-robot k8s-ci-robot merged commit f210d88 into kubernetes:dev-1.25 Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. sig/node Categorizes an issue or PR as relevant to SIG Node. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants