Skip to content

Add missing information to the prometheus.exporter.oracledb component documentation#4910

Merged
dehaansa merged 10 commits intomainfrom
docs/update-prometheus-exporter-oracledb
Dec 8, 2025
Merged

Add missing information to the prometheus.exporter.oracledb component documentation#4910
dehaansa merged 10 commits intomainfrom
docs/update-prometheus-exporter-oracledb

Conversation

@clayton-cornell
Copy link
Contributor

PR Description

Add missing prerequisite and env var information to the prometheus.exporter.oracledb component documentation.

Which issue(s) this PR fixes

Fixes #3891

@clayton-cornell clayton-cornell requested a review from a team November 21, 2025 18:30
@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Nov 21, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 21, 2025

💻 Deploy preview deleted (Add missing information to the prometheus.exporter.oracledb component documentation).

Only the basic version is required for the exporter.

{{< admonition type="note" >}}
The {{< param "PRODUCT_NAME" >}} Docker image includes the Oracle Instant Client, so this prerequisite only applies to standalone binary installations.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not true - #4153

Copy link
Contributor Author

@clayton-cornell clayton-cornell Dec 4, 2025

Choose a reason for hiding this comment

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

Would something like this be more accurate:

When you run the standalone binary, you must install the [Oracle Instant Client Basic](http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html) for your operating system.
Only the basic version is required for the exporter.

{{< admonition type="note" >}}
You must also provide Oracle Instant Client Basic when you run {{< param "PRODUCT_NAME" >}} in Docker or Kubernetes.
The `prometheus.exporter.oracledb` component relies on Oracle Instant Client libraries that are available in the container image or host environment.
{{< /admonition >}}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added this change

@dehaansa dehaansa merged commit 74511a7 into main Dec 8, 2025
44 checks passed
@dehaansa dehaansa deleted the docs/update-prometheus-exporter-oracledb branch December 8, 2025 18:23
grafana-alloybot bot pushed a commit that referenced this pull request Dec 8, 2025
… documentation (#4910)

* Add missing prereq adn env var info

* Fix vars

* Fix table descriptions

* Apply suggestion from @clayton-cornell

* Apply suggestion from @clayton-cornell

(cherry picked from commit 74511a7)
grafana-alloybot bot pushed a commit that referenced this pull request Dec 8, 2025
… documentation (#4910)

* Add missing prereq adn env var info

* Fix vars

* Fix table descriptions

* Apply suggestion from @clayton-cornell

* Apply suggestion from @clayton-cornell

(cherry picked from commit 74511a7)
dehaansa pushed a commit that referenced this pull request Dec 8, 2025
… documentation (#4910) (#5033)

* Add missing prereq adn env var info

* Fix vars

* Fix table descriptions

* Apply suggestion from @clayton-cornell

* Apply suggestion from @clayton-cornell

(cherry picked from commit 74511a7)

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
dehaansa pushed a commit that referenced this pull request Dec 8, 2025
… documentation (#4910) (#5032)

* Add missing prereq adn env var info

* Fix vars

* Fix table descriptions

* Apply suggestion from @clayton-cornell

* Apply suggestion from @clayton-cornell

(cherry picked from commit 74511a7)

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
dehaansa pushed a commit to madhub/alloy that referenced this pull request Dec 10, 2025
… documentation (grafana#4910)

* Add missing prereq adn env var info

* Fix vars

* Fix table descriptions

* Apply suggestion from @clayton-cornell

* Apply suggestion from @clayton-cornell
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 23, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

backport release/v1.11 frozen-due-to-age type/docs Docs Squad label across all Grafana Labs repos

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add missing information to the prometheus.exporter.oracledb component documentation

2 participants