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 otel #3289

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add otel #3289

wants to merge 3 commits into from

Conversation

agardnerIT
Copy link

This PR

  • Adds the otel plugin

This Plugin

Uses tracepusher to generate OpenTelemetry traces for kubectl commands.

@ahmetb
Copy link
Member

ahmetb commented Aug 5, 2023

🤖 Beep beep! I’m a robot speaking on behalf of @ahmetb. 🤖


Thanks for submitting your kubectl plugin to Krew!
One of the krew-index maintainers will review it soon. Note that the reviews for new plugin submissions may take a few days.

In the meanwhile, here are a few tips to make your plugin manifest better:

  • Make sure your plugin follows the best practices.
  • Eliminate redundant wording form shortDescription (it should be max 50 characters).
  • Try to word wrap your description to 80-character lines (no usage examples, please).

Thanks for your patience!
/kind new-plugin

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Aug 5, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: agardnerIT
Once this PR has been reviewed and has the lgtm label, please assign chriskim06 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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
Copy link
Contributor

Welcome @agardnerIT!

It looks like this is your first PR to kubernetes-sigs/krew-index 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/krew-index has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Aug 5, 2023
@ahmetb
Copy link
Member

ahmetb commented Aug 6, 2023

Hi, unless this is an official otel project, we cannot grant this name to your plugin.

@agardnerIT
Copy link
Author

agardnerIT commented Aug 12, 2023

Hi, unless this is an official otel project, we cannot grant this name to your plugin.

Why? Nothing in the plugin naming guide forbids this? The name otel describes what the plugin does. otel is an abbreviation. I would understand if it was called opentelemetry.

What would a valid plugin name be? span? tp? tracepusher? tracer?

kubectl trace is a plugin using bpftrace and that was excepted?

@ahmetb
Copy link
Member

ahmetb commented Aug 13, 2023

I would understand if it was called opentelemetry.

It just so happens otel is practically the de facto name for OpenTelemetry project though?

kubectl trace is a plugin using bpftrace and that was excepted?

You'll find inconsistencies before we started enforcing this. We strive to not to grant first-comer advantage to project/vendor names --or terms like trace that are very common in this domain and therefore could be assigned to more than one project (but would be assigned to the first-comer, an advantage we don't want to grant).

It's not too hard to be creative and still have natural-sounding cmds here like: kubectl traced, tracer, with-trace, with-otel, with-telemetry, ...

/hold
/kind gray-area

@agardnerIT
Copy link
Author

@ahmetb I've spoken to @austinlparker (an OpenTelemetry maintainer) and he stated that he doesn't believe the project reserves otel / OTEL or any variant for use. So we should be OK to proceed here, right?

@austinlparker
Copy link

We don't reserve it from a trademark perspective, certainly.

@austinlparker
Copy link

I would say that I'm not super familiar with this PR but it seems like it only pushes traces? I would probably suggest more specific naming since OpenTelemetry supports metrics, traces, logs, etc.

@ahmetb
Copy link
Member

ahmetb commented Dec 23, 2023

Yeah, otel really isn't a good name for this plugin. It's the means to an end, I think we can get creative and find something better here that doesn't give the impression that this is the official kubectl plugin for otel.

@agardnerIT
Copy link
Author

Correct, this plugin (currently) emits only traces, but there's no reason it couldn't emit metrics and logs (good enhancement).

In terms of naming, strace and trace are both already taken. What about oteltrace?

@ahmetb
Copy link
Member

ahmetb commented Feb 14, 2024

I'll suggest a couple more alternatives that are less likely to be taken away by anyone else:

kubectl traced 
  e.g. kubectl traced get pods 

kubectl otrace

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/new-plugin lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants