close
Skip to content

docs: update documentation for upstream opentelemetry-php-distro rebase (#373)#374

Merged
intuibase merged 8 commits into
elastic:mainfrom
intuibase:docs_update
Apr 30, 2026
Merged

docs: update documentation for upstream opentelemetry-php-distro rebase (#373)#374
intuibase merged 8 commits into
elastic:mainfrom
intuibase:docs_update

Conversation

@intuibase

Copy link
Copy Markdown
Contributor

No description provided.

@intuibase intuibase requested a review from SergeyKleyman April 29, 2026 11:29
@intuibase intuibase self-assigned this Apr 29, 2026
@intuibase intuibase requested a review from a team as a code owner April 29, 2026 11:29
@intuibase intuibase linked an issue Apr 29, 2026 that may be closed by this pull request
@coderabbitai

coderabbitai Bot commented Apr 29, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@intuibase has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 16 minutes and 43 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: ff00137f-d4e2-48d2-8393-8a17b9e406d7

📥 Commits

Reviewing files that changed from the base of the PR and between b31e10f and ec5bc93.

📒 Files selected for processing (2)
  • docs/reference/edot-php/configuration.md
  • docs/reference/edot-php/migration.md
📝 Walkthrough

Walkthrough

This PR updates documentation across the repo: DEVELOPMENT.md is restructured to document the repository/submodule layout, where to make Elastic vs non-Elastic changes, how to update the upstream submodule, and native build instructions now target upstream/prod/native/ (including updated artifact paths, PHP support extended to 8.4, and an adjusted license-header target). Detailed in-repo Docker/Conan/composer workflows were removed in favor of cross-references to the contrib opentelemetry-php-distro upstream docs. Configuration, migration, and release notes switch preferred keys from ELASTIC_OTEL_*/elastic_otel.* to OTEL_PHP_*/opentelemetry_distro.*, mark the old names deprecated, and document precedence rules.

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • 🛠️ Update Documentation: Commit on current branch
  • 🛠️ Update Documentation: Create PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 16 minutes and 43 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/reference/edot-php/configuration.md`:
- Line 76: The docs are missing the legacy alias ELASTIC_OTEL_LOG_LEVEL in the
logging options / deprecated aliases section; update the logging options and
deprecated aliases text to list ELASTIC_OTEL_LOG_LEVEL as a deprecated/legacy
alias for OTEL_PHP_LOG_LEVEL (also mirror the same addition around lines
referenced 132-138), and ensure the example sentence explicitly references both
symbols (ELASTIC_OTEL_LOG_LEVEL -> OTEL_PHP_LOG_LEVEL) so readers see the
migration mapping and preferred name.

In `@docs/release-notes/deprecations.md`:
- Around line 40-70: The deprecation table is missing the legacy env var
ELASTIC_OTEL_LOG_LEVEL and its replacement; add a row mapping
`ELASTIC_OTEL_LOG_LEVEL` to `OTEL_PHP_LOG_LEVEL` in the same table so the 1.5.0
deprecation record is complete and consistent with the other entries (match
formatting used for entries like `ELASTIC_OTEL_LOG_LEVEL_FILE` →
`OTEL_PHP_LOG_LEVEL_FILE`).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: da01db06-d45d-4999-a8c2-6ff09f33fc74

📥 Commits

Reviewing files that changed from the base of the PR and between 56da105 and 23532bf.

📒 Files selected for processing (4)
  • DEVELOPMENT.md
  • docs/reference/edot-php/configuration.md
  • docs/reference/edot-php/migration.md
  • docs/release-notes/deprecations.md

Comment thread docs/reference/edot-php/configuration.md Outdated
Comment thread docs/release-notes/deprecations.md
@github-actions

github-actions Bot commented Apr 29, 2026

Copy link
Copy Markdown

@github-actions

github-actions Bot commented Apr 29, 2026

Copy link
Copy Markdown

✅ Vale Linting Results

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@intuibase intuibase requested a review from alexandra5000 April 30, 2026 09:18
@theletterf

Copy link
Copy Markdown
Member

@alexandra5000 Please have a look — thx!

@alexandra5000 alexandra5000 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! 💟 The content looks accurate and the structure is clear.

A few nitpicks to address before merging, mostly related to the Elastic style guide:

  • Several option descriptions use enable/disable language, which Vale flagged and which Elastic style discourages. I know most of these are pre-existing descriptions where only the env var name was changed, but it's worth fixing them while you're in there.

  • Also we don't use latinisms (via, e.g., etc.) - I also flagged this.

  • Some copy-paste errors.

  • Section anchor change - I would advise against that.

Comment thread docs/reference/edot-php/configuration.md Outdated
Comment thread docs/reference/edot-php/migration.md Outdated
Comment thread docs/reference/edot-php/migration.md Outdated
Comment thread docs/reference/edot-php/migration.md Outdated
Comment thread DEVELOPMENT.md Outdated
Comment thread DEVELOPMENT.md Outdated
Comment thread DEVELOPMENT.md Outdated
Comment thread DEVELOPMENT.md Outdated
Comment thread DEVELOPMENT.md Outdated
Comment thread DEVELOPMENT.md Outdated

@alexandra5000 alexandra5000 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! 💟 The content looks accurate and the structure is clear.

A few nitpicks to address before merging, mostly related to the Elastic style guide:

  • Several option descriptions use enable/disable language, which Vale flagged and which Elastic style discourages. I know most of these are pre-existing descriptions where only the env var name was changed, but it's worth fixing them while you're in there.

  • Also we don't use latinisms (via, e.g., etc.) - I also flagged this.

  • Some copy-paste errors.

  • Section anchor change - I would advise against that.

Co-authored-by: Aleksandra Spilkowska <96738481+alexandra5000@users.noreply.github.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/reference/edot-php/configuration.md`:
- Line 21: Update the broken internal link by changing the anchor target used in
the link text "*EDOT PHP-specific configuration options*" from
"#options-only-available-in-edot-php" to the actual heading-generated anchor
"#edot-php-specific-configuration-options" so the link matches the heading (the
heading on line 62 that produces edot-php-specific-configuration-options) and
the pipeline build will succeed.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: d4c55575-a59b-4577-8701-4348ec24937b

📥 Commits

Reviewing files that changed from the base of the PR and between 23532bf and b31e10f.

📒 Files selected for processing (4)
  • DEVELOPMENT.md
  • docs/reference/edot-php/configuration.md
  • docs/reference/edot-php/migration.md
  • docs/release-notes/deprecations.md

Comment thread docs/reference/edot-php/configuration.md Outdated
@intuibase intuibase requested a review from alexandra5000 April 30, 2026 11:32
Comment thread docs/reference/edot-php/configuration.md Outdated
Comment thread docs/reference/edot-php/configuration.md Outdated

@alexandra5000 alexandra5000 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

2 fixes left to apply, approving to unblock 🚀

@intuibase intuibase merged commit 2bef620 into elastic:main Apr 30, 2026
20 checks passed
@intuibase intuibase deleted the docs_update branch April 30, 2026 12:23
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.

Update documentation for upstream naming conventions

4 participants