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.

Sign up for GitHub

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

Jump to bottom

update lightstep snco docs for rebrand and new demo #13996

Open

cartersocha wants to merge 25 commits into istio:master from cartersocha:istio-docs-update

cartersocha commented Oct 10, 2023

Please provide a description for what this PR is for.

Updating the lightstep integration document for the new rebrand and to remove the deprecated tracers recommendation for the OpenTelemetry equivalent

And to help us figure out who should review this PR, please
put an X in all the areas that this PR affects.


          update lightstep snco docs

ba392a8

cartersocha requested a review from a team as a code owner

October 10, 2023 22:22

istio-policy-bot added the kind/docs label

istio-policy-bot commented Oct 10, 2023

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been a while since you've been here. A few things you should know:

You can learn about how we write and maintain documentation, our style guidelines,
and the available web site features by visiting Contributing to the Docs.
In the next few minutes, an automatic preview of your change will be built with
a full copy of the istio.io website. You can find this preview by clicking on
the Details link next to the deploy/netlify entry in the status section of this
page.
We care about quality, so we've put in place a number of checks to ensure our documentation
is top-notch. We do spell checking, sanitize the Markdown, ensure all hyperlinks point to a
valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
lint_istio.io entry in the status section. Click on the Details link to get a list of the
problems with your PR. Fix those problems and push an update; this will automatically re-run the
tests. Hopefully this time everything will be perfect!
Once your changes are accepted and merged into the repository, they will initially show up
on https://preliminary.istio.io. The changes will be published to https://istio.io
the next time we do a major release (which typically happens every 3 months or so).
To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current
release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

istio-testing added size/L needs-ok-to-test labels

Contributor

istio-testing commented Oct 10, 2023

Hi @cartersocha. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Contributor

ericvn commented Oct 10, 2023

/ok-to-test

istio-testing added ok-to-test and removed needs-ok-to-test labels

cartersocha added 10 commits

October 11, 2023 10:26


          indent

2d2afaa


          update code blocks

907840d


          code blocks

ad948da

6b771e8


          fix indent

18fbfb4

nit

56854b2


          broken link

da0cc12


          istio

c740b41


          spelling

3c83d11


          spelling

f71a4f6

Author

cartersocha commented Oct 11, 2023

thanks @ericvn. This PR is ready for review / passing the relevant checks

ericvn mentioned this pull request

Rebrand and update lightstep docs #13779

Open

9 tasks

windsonsea reviewed

View reviewed changes

Member

windsonsea left a comment

Indent 4 spaces for an ordered list 1-2-3-4. Current preview is not good for the lists:
https://deploy-preview-13996--preliminary-istio.netlify.app/latest/docs/tasks/observability/distributed-tracing/lightstep/

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

cartersocha and others added 7 commits

October 23, 2023 13:19


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

0a6a68c

…tep/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

129e1be

…tep/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

e897b55

…tep/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

a02ee47

…tep/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

bdfb95b

…tep/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

e266e00

…tep/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

b69b1dd

…tep/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>

cartersocha and others added 3 commits

October 23, 2023 13:20


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

194e10d

…tep/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

d3467be

…tep/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

68cdecc

…tep/index.md

Co-authored-by: Michael <haifeng.yao@daocloud.io>

robswhitmore reviewed

View reviewed changes

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated

    
              This task shows you how to configure Istio to collect trace spans and send them to [Lightstep](https://lightstep.com).

              Lightstep lets you analyze 100% of unsampled transaction data from large scale production software to produce meaningful

              This task shows you how to configure Istio to collect trace spans and send them to [ServiceNow Cloud Observability](https://lightstep.com) (SNCO).

              SNCO lets you analyze 100% of unsampled transaction data from large scale production software to produce meaningful

Contributor

robswhitmore Oct 30, 2023

SNCO is not an approved external acronym. We have to spell out Cloud Observability. After the first instance of ServiceNow (in this case in the title), you can omit ServiceNow

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md

@@ @@ -11,8 +11,8 @@ test: no @@
               {{< boilerplate telemetry-tracing-tips >}}
-              This task shows you how to configure Istio to collect trace spans and send them to [Lightstep](https://lightstep.com).
-              Lightstep lets you analyze 100% of unsampled transaction data from large scale production software to produce meaningful
+              This task shows you how to configure Istio to collect trace spans and send them to [ServiceNow Cloud Observability](https://lightstep.com) (SNCO).

Contributor

robswhitmore Oct 30, 2023

Suggested change

      
            This task shows you how to configure Istio to collect trace spans and send them to [ServiceNow Cloud Observability](https://lightstep.com) (SNCO).
          
            This task shows you how to configure Istio to collect trace spans and send them to [Cloud Observability](https://lightstep.com).

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md Outdated Show resolved Hide resolved

windsonsea reviewed

View reviewed changes

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md

    
              1.  Ensure sure you have a Lightstep [access token](https://docs.lightstep.com/docs/create-and-manage-access-tokens). Access tokens allow your app to communicate with your Lightstep project.

              Before installing Istio you will need to have a Kubernetes cluster running a supported version of Kubernetes. For Istio v.19 this is Kubernetes versions 1.25, 1.26, 1.27 or 1.28. See here for a list of supported Kubernetes versions if you are installing a different version of Istio.

Member

windsonsea Nov 2, 2023

Note to add a link here to check a full list of k8s versions.

Contributor

craigbox Nov 9, 2023

You don't want to have to main this, so just assume that someone has Istio (or link to a setup guide) and give the specific changes for Cloud Observability.

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md

    
              How you deploy Istio depends on which type of Satellite you use.

              1. Use the following command to download and extract the latest Istio release for your operating system (Linux of macOS). For other releases and operating systems, download the your installation file from the Istio releases page

Member

windsonsea Nov 2, 2023

Linux or macOS?

craigbox and others added 4 commits

November 9, 2023 13:02


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

8c8f74c

…tep/index.md

Co-authored-by: Robin Whitmore <50384513+robswhitmore@users.noreply.github.com>


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

a934652

…tep/index.md

Co-authored-by: Robin Whitmore <50384513+robswhitmore@users.noreply.github.com>


          Update content/en/docs/tasks/observability/distributed-tracing/lights…

2d558b7

…tep/index.md

Co-authored-by: Robin Whitmore <50384513+robswhitmore@users.noreply.github.com>


          Apply suggestions from code review

7f303ee

Co-authored-by: Robin Whitmore <50384513+robswhitmore@users.noreply.github.com>
Co-authored-by: Michael <haifeng.yao@daocloud.io>

craigbox reviewed

View reviewed changes

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md

@@ @@ -1,6 +1,6 @@ @@
               ---
-              title: Lightstep
-              description: How to configure the proxies to send tracing requests to Lightstep.
+              title: ServiceNow Cloud Observability (Lightstep)

Contributor

craigbox Nov 9, 2023

Suggested change

      
            title: ServiceNow Cloud Observability (Lightstep)
          
            title: ServiceNow Cloud Observability (formerly Lightstep)

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md

    
              title: Lightstep

              description: How to configure the proxies to send tracing requests to Lightstep.

              title: ServiceNow Cloud Observability (Lightstep)

              description: How to configure the proxies to send tracing requests to ServiceNow Cloud Observability (Lightstep).

Contributor

craigbox Nov 9, 2023

Suggested change

      
            description: How to configure the proxies to send tracing requests to ServiceNow Cloud Observability (Lightstep).
          
            description: How to configure the proxies to send tracing requests to ServiceNow Cloud Observability.

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md

    
              title: Lightstep

              description: How to configure the proxies to send tracing requests to Lightstep.

              title: ServiceNow Cloud Observability (Lightstep)

              description: How to configure the proxies to send tracing requests to ServiceNow Cloud Observability (Lightstep).

              weight: 11

              keywords: [telemetry,tracing,lightstep]

              aliases:

Contributor

craigbox Nov 9, 2023

I would be inclined to rename this page to servicenow-cloud-observability/index.md and set up an alias for lightstep/index.md so that it redirects.

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md

@@ @@ -11,8 +11,8 @@ test: no @@
               {{< boilerplate telemetry-tracing-tips >}}
-              This task shows you how to configure Istio to collect trace spans and send them to [Lightstep](https://lightstep.com).
-              Lightstep lets you analyze 100% of unsampled transaction data from large scale production software to produce meaningful
+              This task shows you how to configure Istio to collect trace spans and send them to [ServiceNow Cloud Observability](https://lightstep.com) (SNCO).

Contributor

craigbox Nov 9, 2023

use new URL

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md

    
              1.  Ensure sure you have a Lightstep [access token](https://docs.lightstep.com/docs/create-and-manage-access-tokens). Access tokens allow your app to communicate with your Lightstep project.

              Before installing Istio you will need to have a Kubernetes cluster running a supported version of Kubernetes. For Istio v.19 this is Kubernetes versions 1.25, 1.26, 1.27 or 1.28. See here for a list of supported Kubernetes versions if you are installing a different version of Istio.

Contributor

craigbox Nov 9, 2023

You don't want to have to main this, so just assume that someone has Istio (or link to a setup guide) and give the specific changes for Cloud Observability.

content/en/docs/tasks/observability/distributed-tracing/lightstep/index.md

-              that the call took 15.30 ms. The second span is labeled with the `reviews.default.svc.cluster.local:9080/*` operation
-              and the `reviews.default: proxy server` service. The second span is a child of the first span and represents the
-              server-side span of the call. The screenshot shows that the call took 14.60 ms.
+              * [Configure Istio to Send Metrics to Cloud Observability](https://docs.lightstep.com/integrations/ingest-metrics-istio)

Contributor

craigbox Nov 9, 2023

are these valid with new product name?

Contributor

istio-testing commented Nov 9, 2023

@cartersocha: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
lint_istio.io	`7f303ee`	link	true	`/test lint`

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

istio-testing added the needs-rebase label

Contributor

istio-testing commented Mar 6, 2024

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment