Skip to content

[Cloud Run] Split up In-Process docs #30742

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

Merged
merged 54 commits into from
Aug 7, 2025

Conversation

nhulston
Copy link
Contributor

@nhulston nhulston commented Jul 28, 2025

What does this PR do? What is the motivation?

  • Rewrite container in-process docs by breaking them up into a unique page for each runtime
  • Use shortcodes to avoid duplicated content
  • Break docs into logical steps: (1) install tracer, (2) install agent, (3) setup logs, and (4) configure
  • Simplified the instrumentation instructions as much as possible, while still verifying they work. All my test apps that I used to verify these docs can be found in Add In-Process Sample Apps serverless-gcp-sample-apps#5

https://datadoghq.atlassian.net/browse/SVLS-7302

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

Will get to Sidecar Containers in a future PR. Then, Gen 2 functions

@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Jul 28, 2025
Copy link
Contributor

github-actions bot commented Jul 28, 2025

✅ Documentation Team Review

The documentation team has approved this pull request. Thank you for your contribution!

Copy link
Contributor

github-actions bot commented Jul 28, 2025

Preview links (active after the build_preview check completes)

New or renamed files

Removed or renamed files (these should redirect)

Renamed files

@nhulston nhulston added the WORK IN PROGRESS No review needed, it's a wip ;) label Jul 28, 2025
@nhulston nhulston force-pushed the nicholas.hulston/gcr-split-up-in-process-docs branch from 0f697fe to c1241d7 Compare July 28, 2025 20:25
Copy link
Contributor

@apiarian-datadog apiarian-datadog left a comment

Choose a reason for hiding this comment

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

i like that we're pulling the language docs apart. is this the standard way to do it in the docs repo?

i do have some concerns about the serverless init setup docs and the environment variables, though.

@nhulston
Copy link
Contributor Author

nhulston commented Jul 29, 2025

i like that we're pulling the language docs apart. is this the standard way to do it in the docs repo?

@apiarian-datadog
Yes, I was inspired by this page: https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/dd_libraries/python/

@nhulston nhulston added serverless GAS Serverless GCP & Azure and removed WORK IN PROGRESS No review needed, it's a wip ;) labels Jul 31, 2025
@rtrieu rtrieu added the editorial review Waiting on a more in-depth review label Jul 31, 2025
@rtrieu
Copy link
Contributor

rtrieu commented Jul 31, 2025

Created a DOCS card for a more in-depth review.

text: 'Correlating .NET Logs and Traces'
---

## 1. Install the Tracer
Copy link
Contributor

Choose a reason for hiding this comment

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

do we have public sample apps we can link to?

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 thought we decided not to link to sample apps? I will ask Piyali

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay got confirmation, we can link them!

@nhulston nhulston force-pushed the nicholas.hulston/gcr-split-up-in-process-docs branch from f78669a to 1302b66 Compare August 4, 2025 14:54
@cswatt cswatt self-assigned this Aug 4, 2025
Copy link
Contributor

@apiarian-datadog apiarian-datadog left a comment

Choose a reason for hiding this comment

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

looking good.


For more information, see [Correlating .NET Logs and Traces][3].

4. **Configure your application**.
Copy link
Contributor

Choose a reason for hiding this comment

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

should we include some a note in here or somewhere else about the service label thing in cloud run?

Copy link
Contributor

Choose a reason for hiding this comment

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

we can always improve further! but since this PR touches a lot of files and has a high potential of running into merge conflicts if we keep it open much longer, I'd like to merge this and tackle further changes in a new PR.

@cswatt cswatt merged commit afa621c into master Aug 7, 2025
26 checks passed
@cswatt cswatt deleted the nicholas.hulston/gcr-split-up-in-process-docs branch August 7, 2025 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review GAS Serverless GCP & Azure serverless
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants