Skip to content

Conversation

@trentm
Copy link
Member

@trentm trentm commented Jul 28, 2025

Fixes: elastic/elastic-otel-node#869
Refs: elastic/elastic-otel-node#889 (review)

- Update deep links to opentelemetry-js-contrib due to directory moves in that repo.
- Supported technologies table updates:
    - Point to instrumentation-redis rather than instrumentation-redis-4. The former was accidentally not included, and the latter is now rolled into the former (elastic/elastic-otel-node#889).
    - Mention some included instrumentations that were missing from this table: connect, cucumber, dns, runtime-node

Fixes: elastic/elastic-otel-node#869
Refs: elastic/elastic-otel-node#889 (review)
@trentm
Copy link
Member Author

trentm commented Jul 28, 2025

@theletterf (/cc @Mpdreamz) what do I do about this docs-build crash?

https://github.com/elastic/opentelemetry/actions/runs/16578203972/job/46887665165?pr=375

Error: Uncaught exception while processing file
System.ArgumentException: Markdown elements in the input are too deeply nested - depth limit exceeded. Input is most likely not sensible or is a very large table.
   at Markdig.Helpers.ThrowHelper.<CheckDepthLimit>g__DepthLimitExceeded|16_0() + 0x27
   at Markdig.Renderers.RendererBase.WriteChildren(ContainerInline) + 0x86
   at Elastic.Markdown.Myst.Renderers.HtmxLinkInlineRenderer.Write(HtmlRenderer, LinkInline) + 0x40e
   at Markdig.Renderers.RendererBase.Write(MarkdownObject) + 0xd2
...
    at Elastic.Markdown.HtmlWriter.<RenderLayout>d__20.MoveNext() + 0x89
--- End of stack trace from previous location ---
   at Elastic.Markdown.HtmlWriter.<WriteAsync>d__21.MoveNext() + 0x3e8
--- End of stack trace from previous location ---
   at Elastic.Markdown.Exporters.DocumentationFileExporter.<ProcessFile>d__3.MoveNext() + 0x5a
--- End of stack trace from previous location ---
   at Elastic.Markdown.DocumentationGenerator.<ProcessFile>d__27.MoveNext() + 0x3e4
--- End of stack trace from previous location ---
   at Elastic.Markdown.DocumentationGenerator.<>c__DisplayClass24_0.<<ProcessDocumentationFiles>b__0>d.MoveNext() + 0x75 (reference/edot-sdks/nodejs/supported-technologies.md:0)

I assume this is because I added a few rows to this existing Markdown table: https://github.com/elastic/opentelemetry/pull/375/files#diff-0beabc8fec73e207ac0aec1a40e68c8a65306e9848186d4a11eda2375825c677R47

FWIW, GitHub renders it fine: https://github.com/elastic/opentelemetry/blob/trentm-edot-node-updates/docs/reference/edot-sdks/nodejs/supported-technologies.md#instrumentations-instrumentations

I look more carefully to see if I made a Markdown syntax error in my changes, but from the error message is feels like I just hit it with too big of a table?

@trentm
Copy link
Member Author

trentm commented Jul 28, 2025

If we need a short term workaround, it would be fine to exclude a few of the rows for less important instrumentations.

Co-authored-by: Colleen McGinnis <[email protected]>
@github-actions
Copy link
Contributor

github-actions bot commented Jul 28, 2025

@trentm trentm requested a review from colleenmcginnis July 28, 2025 22:19
Copy link
Collaborator

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

Thank you!

@theletterf theletterf merged commit 4eeacba into main Jul 29, 2025
5 checks passed
@trentm trentm deleted the trentm-edot-node-updates branch July 29, 2025 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

instr-runtime-node is missing from docs' list of included instrumentations

4 participants