Skip to content

[Oracle] Document alternate method of adding runtime library path - #8754

Merged
agithomas merged 9 commits into
elastic:mainfrom
agithomas:issue-8750
Jan 4, 2024
Merged

agithomas merged 9 commits into
elastic:mainfrom
agithomas:issue-8750

Conversation

@agithomas

@agithomas agithomas commented Dec 19, 2023 •

Copy link
Copy Markdown
Contributor
  • Enhancement

Proposed commit message

Setting the runtime library path is essential for Oracle Integration to work.
Document additional methods of setting the runtime library path by setting values in elastic-agent configuration.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

How to test this PR locally

  • elastic-package build
  • elastic-package stack up -v -d --services package-registry

Related issues

#8750

Screenshots

image

@elasticmachine

elasticmachine commented Dec 19, 2023 •

Copy link
Copy Markdown

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-12-19T12:49:51.229+0000

  • Duration: 35 min 3 sec

Test stats 🧪

Test Results
Failed 0
Passed 26
Skipped 0
Total 26

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine

elasticmachine commented Dec 19, 2023 •

Copy link
Copy Markdown

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (1/1) 💚
Files 100.0% (1/1) 💚 3.905
Classes 100.0% (1/1) 💚 3.905
Methods 100.0% (29/29) 💚 7.808
Lines 94.424% (254/269) 👍 5.794
Conditionals 100.0% (0/0) 💚

@elasticmachine

Copy link
Copy Markdown

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

@agithomas
agithomas marked this pull request as ready for review December 19, 2023 13:25
@agithomas
agithomas requested a review from a team as a code owner December 19, 2023 13:25

The OCI library install few Client Shared Libraries that must be referenced on the machine where Metricbeat is installed. Please follow the [Oracle Client Installation link](https://docs.oracle.com/en/database/oracle/oracle-database/21/lacli/install-instant-client-using-zip.html#GUID-D3DCB4FB-D3CA-4C25-BE48-3A1FB5A22E84) link for OCI Instant Client set up. The OCI Instant Client is available with the Oracle Universal Installer, RPM file or ZIP file. Download links can be found at the [Oracle Instant Client Download page](https://www.oracle.com/database/technologies/instant-client/downloads.html).

If the Elastic Agent is running as a systemd service and there are limitations in running `ldconfig` command, you can set the library search path using an alternate method. Follow the steps below to achieve this.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
If the Elastic Agent is running as a systemd service and there are limitations in running `ldconfig` command, you can set the library search path using an alternate method. Follow the steps below to achieve this.
If Elastic Agent is running as a systemd service and using `ldconfig` is not an option to update the links to the shared libraries, you can use the `LD_LIBRARY_PATH` environment variable instead. Follow these steps to ensure Elastic Agent and its spawned processes respect the `LD_LIBRARY_PATH` environment variable.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggest change is clearer IMO as LD_LIBRARY_PATH is the alternative method. So we are helping our users set environment variables for Elastic Agent and the processes spawned by the same.

Comment thread packages/oracle/manifest.yml Resolved
@shmsr shmsr added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request labels Dec 20, 2023
Comment thread packages/oracle/changelog.yml Resolved
@mrodm

mrodm commented Dec 21, 2023

Copy link
Copy Markdown
Collaborator

Hi @agithomas, please update your branch with the latest contents from main branch. There was an important PR merged updating the CI pipelines. Thanks!

@agithomas
agithomas requested a review from shmsr December 22, 2023 06:25
@shmsr

shmsr commented Dec 22, 2023

Copy link
Copy Markdown
Member

LGTM. After @muthu-mps's comments are merged, we can merge this.

@agithomas
agithomas requested a review from muthu-mps December 22, 2023 12:31
@agithomas

Copy link
Copy Markdown
Contributor Author

All comments are addressed. @muthu-mps , @shmsr , please approve the PR, if no further changes are needed.

@agithomas
agithomas merged commit 0dd44f9 into elastic:main Jan 4, 2024
@elasticmachine

Copy link
Copy Markdown

Package oracle - 1.24.0 containing this change is available at https://epr.elastic.co/search?package=oracle

@agithomas
agithomas deleted the issue-8750 branch February 12, 2025 04:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:oracle Oracle

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

⌂ 换网址