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

Rework and consolidate OTLP configuration related pages #17169

Merged
merged 16 commits into from
May 7, 2024

Conversation

jack-berg
Copy link
Contributor

@jack-berg jack-berg commented May 1, 2024

  • Extract and rework all OTLP config related content into a single page
    • Delete and merge OpenTelemetry -> Export OpenTelemetry to New Relic -> Attribute length
    • Delete and merge OpenTelemetry -> Export OpenTelemetry to New Relic -> Batching
    • Delete and merge OpenTelemetry -> Export OpenTelemetry to New Relic -> Compression
    • Delete and mergeOpenTelemetry -> Export OpenTelemetry to New Relic -> OTLP versions
    • Extract OTLP endpoint details from OpenTelemetry -> Get started -> Set up your own app
  • Rename navigation OpenTelemetry -> Export OpenTelemetry to New Relic to OpenTelemetry -> Export with OTLP
    • New OTLP config page is a child with name OTLP Configuration
    • Data Mapping child renamed to OTLP Data Mapping to make the content more clear
  • Delete unused opentelemetry-best-practices-overview.mdx document, which seems to be a remnant from the recent refactor
  • Add new OTLP Troubleshooting page with content from draft doc

Copy link

github-actions bot commented May 1, 2024

Hi @jack-berg 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues May 1, 2024
Copy link

netlify bot commented May 1, 2024

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 4bf0ea3
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/66396bd65972060008845861
😎 Deploy Preview https://deploy-preview-17169--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ally-sassman ally-sassman self-assigned this May 2, 2024
@ally-sassman ally-sassman added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) labels May 2, 2024
@homelessbirds homelessbirds moved this from Hero to triage to In progress in Docs PRs and Issues May 2, 2024
@ally-sassman ally-sassman self-requested a review May 6, 2024 16:09
@jack-berg jack-berg mentioned this pull request May 6, 2024
@ally-sassman ally-sassman merged commit bbf616b into newrelic:develop May 7, 2024
13 checks passed

* If you haven't already done so, sign up for a free [New Relic account](https://newrelic.com/signup).
* Get the [license key](https://one.newrelic.com/launcher/api-keys-ui.launcher) for the New Relic account to which you want to report data. This license key will be used to [configure the `api-key` header](#api-key).
* Review your OTLP version: New Relic uses [OTLP release v0.18.0](https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.18.0). Later versions are supported but new features are not yet implemented. Experimental features which were are no longer available in 0.18.0 are not supported.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey I noticed this change just now. This is the type of info that users should be able to find, but doesn't need to be top of page. It won't matter to almost all users, and I think putting it up here prominently might bring unnecessary FUD.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers)
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants