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

[cmd/telemetrygen] Add TLS/mTLS support to telemetrygen #29681

Merged
merged 12 commits into from
Jan 10, 2024

Conversation

Juliaj
Copy link
Contributor

@Juliaj Juliaj commented Dec 7, 2023

Description:
Implementing robust security measures is essential for any tracing ingestion service and infrastructure. This adds TLS/mTLS support to telemetrygen traces so that it can be used to test the security implementation. To illustrate the usage, a new example, secure-tracing is added to examples collection.

Link to tracking Issue:

Testing:
Tested with the secure-tracing example.

Documentation:

  • telemetrygen README has been updated with a link to secure-tracing.
  • secure-tracing README contains setup of a testing environment and test script via telemetrygen

@Juliaj Juliaj requested a review from a team December 7, 2023 00:25
@github-actions github-actions bot added the cmd/telemetrygen telemetrygen command label Dec 7, 2023
Copy link
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! Some notes:

  • Let's move the timeout functionality to a different PR since this is separate and we can discuss there in detail
  • If you want to add examples, they need to be tested on CI to ensure we don't break them
  • The current implementation is specific to traces. I think we can add it for all signals instead

examples/secure-tracing/README.md Outdated Show resolved Hide resolved
examples/secure-tracing/README.md Show resolved Hide resolved
examples/secure-tracing/README.md Outdated Show resolved Hide resolved
cmd/telemetrygen/internal/traces/exporter.go Outdated Show resolved Hide resolved
cmd/telemetrygen/internal/traces/config.go Outdated Show resolved Hide resolved
@Juliaj Juliaj force-pushed the telemetrygen_tls_secure_tracing branch from 914c85a to fd55b0a Compare January 2, 2024 21:17
@Juliaj Juliaj changed the title [cmd/telemetrygen] Add TLS/mTLS support to telemetrygen traces [cmd/telemetrygen] Add TLS/mTLS support to telemetrygen Jan 3, 2024
Makefile Show resolved Hide resolved
cmd/telemetrygen/internal/traces/config.go Show resolved Hide resolved
examples/secure-tracing/otel-collector-config.yaml Outdated Show resolved Hide resolved
examples/secure-tracing/otel-collector-config.yaml Outdated Show resolved Hide resolved
examples/secure-tracing/docker-compose.yaml Outdated Show resolved Hide resolved
examples/secure-tracing/README.md Show resolved Hide resolved
cmd/telemetrygen/internal/traces/exporter.go Outdated Show resolved Hide resolved
cmd/telemetrygen/internal/logs/exporter.go Outdated Show resolved Hide resolved
cmd/telemetrygen/internal/logs/exporter.go Outdated Show resolved Hide resolved
cmd/telemetrygen/internal/common/config.go Outdated Show resolved Hide resolved
@Juliaj Juliaj force-pushed the telemetrygen_tls_secure_tracing branch from f9e0e89 to bd24163 Compare January 5, 2024 01:28
cmd/telemetrygen/internal/logs/exporter.go Outdated Show resolved Hide resolved
cmd/telemetrygen/internal/logs/exporter.go Outdated Show resolved Hide resolved
.chloggen/juliaj_telemetrygen-tls-mtls-support.yaml Outdated Show resolved Hide resolved
@Juliaj Juliaj force-pushed the telemetrygen_tls_secure_tracing branch from 2981d2c to 3a74ad7 Compare January 5, 2024 16:17
@mx-psi
Copy link
Member

mx-psi commented Jan 8, 2024

#29681 (comment) was hidden, it's only a nit so please only address if you think it makes sense :)

@Juliaj Juliaj force-pushed the telemetrygen_tls_secure_tracing branch from f6556ba to 9b51aab Compare January 8, 2024 17:44
@Juliaj Juliaj force-pushed the telemetrygen_tls_secure_tracing branch from f65ff8c to 2ed169d Compare January 9, 2024 05:28
@Juliaj
Copy link
Contributor Author

Juliaj commented Jan 9, 2024

#29681 (comment) was hidden, it's only a nit so please only address if you think it makes sense :)

Thanks for the suggestion. Updated.

@Juliaj
Copy link
Contributor Author

Juliaj commented Jan 9, 2024

@mx-psi , I made a minor change to add some instructions to README to deal with missing certs and a helper in Makefile to remove the folder generated. See commit, thanks!

@mx-psi mx-psi merged commit 46bf579 into open-telemetry:main Jan 10, 2024
85 checks passed
@github-actions github-actions bot added this to the next release milestone Jan 10, 2024
cparkins pushed a commit to AmadeusITGroup/opentelemetry-collector-contrib that referenced this pull request Jan 10, 2024
…ry#29681)

**Description:** 
Implementing robust security measures is essential for any tracing
ingestion service and infrastructure. This adds TLS/mTLS support to
telemetrygen traces so that it can be used to test the security
implementation. To illustrate the usage, a new example, `secure-tracing`
is added to examples collection.

**Link to tracking Issue:** <Issue number if applicable>

**Testing:** 
Tested with the `secure-tracing` example.

**Documentation:** 
- telemetrygen README has been updated with a link to secure-tracing. 
- secure-tracing README contains setup of a testing environment and test
script via telemetrygen
@Juliaj Juliaj deleted the telemetrygen_tls_secure_tracing branch February 2, 2024 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cmd/telemetrygen telemetrygen command
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants