Skip to content

docs: adds information about the Envoy tracer from Instana#6371

Closed
noctarius wants to merge 4 commits intoenvoyproxy:masterfrom
noctarius:docs-instana
Closed

docs: adds information about the Envoy tracer from Instana#6371
noctarius wants to merge 4 commits intoenvoyproxy:masterfrom
noctarius:docs-instana

Conversation

@noctarius
Copy link
Copy Markdown
Contributor

Description: This PR adds the information for the Envoy tracer from Instana and also the HTTP headers being used to capture traces and spans. The information are written in the same way as for Zipkin, Datadog and others.
Risk Level: Low
Testing: n/a, doc change only
Docs Changes: See above, only doc change
Release Notes: no impact on users, no necessity to be mentioned in the release notes

PS: I hope this change is done according to the contributions best practices. If I missed anything, just let me know, happy to fix it.

Signed-off-by: noctarius <me@noctarius.com>
Signed-off-by: noctarius <me@noctarius.com>
Signed-off-by: noctarius <me@noctarius.com>
Signed-off-by: noctarius <me@noctarius.com>
@mattklein123 mattklein123 self-assigned this Mar 25, 2019
@mattklein123
Copy link
Copy Markdown
Member

@noctarius thanks for the contribution, but as this is an extension that isn't in the repo, I'm not sure these headers belong in the public docs. Can you potentially provide some more context on this PR?

/wait-any

@noctarius
Copy link
Copy Markdown
Contributor Author

@mattklein123 thank you for taking the time to look into it. I'm looking into to make sure, people understand what options they have when monitoring Envoy (and with that Istio too), and there's not only one commercial vendor to support it.

I saw that all the other tracer extensions are part of the Envoy code base, but I wonder if that's a requirement. We provide the ready to use extension and otherwise work the same way as any bundled extension. A quick insight into how to use the Instana Envoy sensor is here: https://www.instana.com/blog/monitoring-envoy-proxy-microservices/

I hope this is a meaningful request and you understand our reasoning. If I can provide more insight oder add more content to make the request worthwhile, I'm happy to do this.

@mattklein123
Copy link
Copy Markdown
Member

@noctarius given that this filter is not in the repo, I'm not sure it makes sense to fully document the headers. What about something like the following:

  1. Add your company/product to https://www.envoyproxy.io/community
  2. Potentially refactor the tracing overview doc page to have a list of additional external tracing solutions compatible with Envoy but not in the repo, and a link to your product?

WDYT?

/wait

@noctarius
Copy link
Copy Markdown
Contributor Author

Hey Matt, thank you very much for the help, I love the idea. I actually only added the headers since just a name and link didn't seem any meaningful to me, however reworking the page a bit makes sense.

Is that about what you meant with changing the tracing page? https://github.com/noctarius/envoy/blob/instana-docs/docs/root/intro/arch_overview/tracing.rst

On the other side, I couldn't find any way to change the website, therefore I think I'd offer a logo and you would add it into the community page you mentioned?

@mattklein123
Copy link
Copy Markdown
Member

@noctarius the website code is here: https://github.com/envoyproxy/envoyproxy.github.io. Feel free to do a direct PR to that repo for your proposed changes. cc @lucperkins @caniszczyk

@mattklein123
Copy link
Copy Markdown
Member

@noctarius that change to the tracing docs generally LGTM. If you want to update the PR we can discuss during code review.

@noctarius noctarius closed this Mar 28, 2019
@noctarius noctarius deleted the docs-instana branch March 28, 2019 17:39
mattklein123 pushed a commit that referenced this pull request Mar 28, 2019
Signed-off-by: Christoph Engelbert <me@noctarius.com>
spenceral added a commit to spenceral/envoy that referenced this pull request Mar 29, 2019
* master:
  router: support prefix wildcards in virtual hosts domains (envoyproxy#6303)
  security: update distributor application example to include e-mail. (envoyproxy#6425)
  Examples: Update gen script of grpc example service (envoyproxy#6372)
  config: de-templatize source/common/config (envoyproxy#6391)
  docs: adds information about the Envoy tracer from Instana envoyproxy#6371 (envoyproxy#6416)
  test: convert ratelimit test configs to v2 YAML (envoyproxy#6411)
  include required python and go dependencies for grpc-bridge example (envoyproxy#6402)
  docs: more snapping fixes (envoyproxy#6404)
  runtime: switching from unordered_map to absl::flat_hash_map (envoyproxy#6389)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants