Skip to content

Conversation

@jhadobe
Copy link
Contributor

@jhadobe jhadobe commented Jul 14, 2025

This PR adds several pages regarding open telemetry for the integration starter kit.

Staging: https://developer-stage.adobe.com/commerce/extensibility/starter-kit/integration/telemetry/
repurposed while this PR is on hold

@jhadobe jhadobe self-assigned this Jul 14, 2025
@jhadobe jhadobe added the new-topic A major update published as an entirely new document label Jul 14, 2025
@github-project-automation github-project-automation bot moved this to 📋 Needs Review in Commerce - Pull Requests Jul 14, 2025
@jhadobe jhadobe requested a review from nejo July 18, 2025 18:58
@jhadobe jhadobe marked this pull request as ready for review July 18, 2025 18:59

## Setup

In order for Adobe Commerce runtime actions to send telemetry signals to New Relic, you must configure the telemetry exporters to send data to the Open Telemetry Protocol (OTLP) ingestion endpoint provided by the platform.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In order for Adobe Commerce runtime actions to send telemetry signals to New Relic, you must configure the telemetry exporters to send data to the Open Telemetry Protocol (OTLP) ingestion endpoint provided by the platform.
For Adobe Commerce runtime actions to send telemetry signals to New Relic, you must configure the telemetry exporters to send data to the Open Telemetry Protocol (OTLP) ingestion endpoint provided by the platform.

Copy link
Collaborator

Choose a reason for hiding this comment

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

This is kind of not accurate? This library works for any App Builder runtime actions, not only for Adobe Commerce.

@jhadobe jhadobe requested a review from keharper July 30, 2025 21:59
@iivvaannxx
Copy link
Collaborator

I unresolved some of the conversations with some notes of my own (some of them are collapsed by the UI, make sure you go over all of them).

I applied some of the documentation suggestions listed by @keharper so that they auto-generate from source code with those changes. You can find latest docs state in here: adobe/aio-lib-telemetry#18

@iivvaannxx
Copy link
Collaborator

@keharper @jhadobe Not sure if this kind of reference is the first of it's kind (not an API, not a GraphQL, but a library reference) in Adobe documentation, but I'd seriously avoid manually modifying it as it will be a maintenance hell.

I can automate a process that opens a PR in the Adobe documentation anywhere with the latest docs whenever a release of the library happens, if that eases the documentation workflow a bit.

If you have concerns on the format we can have a talk on what can be improved or what you'd like to see different (acknowledging that there will be limitations). Let me know if this would work for you.

FYI, the reference is generated from source code via TypeDoc combined with the Markdown plugin. Linking to both in case you want to investigate (if you're not familiar with them already).

@iivvaannxx
Copy link
Collaborator

Also going to leave some examples here on what I have in mind for a "library API Reference", which is something I'm used to look when working with third-party libraries.

@jhadobe jhadobe marked this pull request as draft August 4, 2025 15:32
@jhadobe
Copy link
Contributor Author

jhadobe commented Aug 4, 2025

Reverting this to a draft state, it will be on hold for a couple weeks. (Pending PM input on where these docs should be published.)

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

Labels

new-topic A major update published as an entirely new document

Projects

Status: 📋 Needs Review

Development

Successfully merging this pull request may close these issues.

4 participants