Update SQL and Oracle module docs regarding Oracle DSNs #37590

chrisberkhout · 2024-01-10T10:22:55Z

Proposed commit message

Update SQL and Oracle module docs regarding Oracle DSNs (#37590)

- Add 'oracle://' URL format.
- Add note about encoding of special characters in URLs.
- Align the SQL module and the Oracle module documentation.

Checklist

~~My code follows the style guidelines of this project~~
~~I have commented my code, particularly in hard-to-understand areas~~
I have made corresponding changes to the documentation
~~I have made corresponding change to the default configuration files~~
~~I have added tests that prove my fix is effective or that my feature works~~
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

How to test this PR locally

The SQL and Oracle modules both use the GO DRiver for ORacle DB to parse Oracle DSNs. I tested the parsing of the DSN formats with the following script.

DSN parsing script

Script:

package main

import (
	"fmt"

	"github.com/godror/godror"
)

func main() {
	params, err := godror.ParseDSN("oracle://user:pa%[email protected]:1521/ORCLPDB1.localdomain?sysdba=1") // ok
	// params, err := godror.ParseDSN("user/pa%[email protected]:1521/ORCLPDB1.localdomain?sysdba=1") // not ok
	// params, err := godror.ParseDSN("user/[email protected]:1521/ORCLPDB1.localdomain?sysdba=1") // ok
	// params, err := godror.ParseDSN("user/[email protected]:1521/ORCLPDB1.localdomain as sysdba") // ok
	// params, err := godror.ParseDSN("user=\"user\" password=\"pass\" connectString=\"0.0.0.0:1521/ORCLPDB1.localdomain\"") // ok
	// params, err := godror.ParseDSN("user=\"user\" password=\"pass\\\\word\" connectString=\"host:port/service_name\" sysdba=true") // ok

	if err != nil {
		fmt.Println(err)
	} else {
		fmt.Println(params)
		fmt.Println(params.Password.Secret())
	}
}

Output:

user=user password=SECRET-*** connectString=0.0.0.0:1521/ORCLPDB1.localdomain
configDir= connectionClass= enableEvents=0 externalAuth=0 heterogeneousPool=0
libDir= noTimezoneCheck=0 poolIncrement=1 poolMaxSessions=1000 poolMinSessions=1
poolSessionMaxLifetime=1h0m0s poolSessionTimeout=5m0s poolWaitTimeout=30s
prelim=0 standaloneConnection=0 sysasm=0 sysdba=1 sysoper=0 timezone=
pa ss

Related issues

Superseds Update SQL input documentation regarding Oracle DSNs #37582

elasticmachine · 2024-01-10T10:23:20Z

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

mergify · 2024-01-10T10:23:32Z

⚠️ The sha of the head commit of this PR conflicts with #37582. Mergify cannot evaluate rules on this PR. ⚠️

mergify · 2024-01-10T10:25:40Z

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @chrisberkhout? 🙏.
For such, you'll need to label your PR with:

The upcoming major version of the Elastic Stack
The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

elasticmachine · 2024-01-10T10:29:52Z

💚 Build Succeeded

Expand to view the summary

Build stats

Start Time: 2024-01-10T10:23:14.086+0000
Duration: 7 min 33 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

elasticmachine · 2024-01-10T10:35:07Z

💔 Build Failed

Expand to view the summary

Build stats

Duration: 5 min 59 sec

Steps errors

Expand to view the steps failures

`Shell Script`

Took 0 min 0 sec . View more details here
Description: git diff --name-only origin/main...bdf4017f9456e51eac7935290740d8dd830c80ea > git-diff.txt

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

elasticmachine · 2024-01-10T10:43:48Z

💚 Build Succeeded

Expand to view the summary

Build stats

Duration: 8 min 3 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

ebeahan

LGTM.

Looks like this also needs reviewed from @elastic/obs-infraobs-integrations as codeowners.

metricbeat/docs/modules/sql.asciidoc

elasticmachine · 2024-01-23T19:15:40Z

❕ Build Aborted

Expand to view the summary

Build stats

Duration: 7 min 37 sec

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

elasticmachine · 2024-01-23T19:19:23Z

💚 Build Succeeded

Expand to view the summary

Build stats

Duration: 9 min 20 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

elasticmachine · 2024-01-23T19:45:58Z

💚 Build Succeeded

Expand to view the summary

Build stats

Duration: 8 min 28 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

lalit-satapathy · 2024-01-24T05:15:21Z

My understanding of the current usage is:

If old style is used: password will need URL encoding.
If DSN style is used: URL encoding is not needed. I don't think it requires a URL encoding, since password is provided directly.

I do agree some explicit clarification is needed in the current wordings.

elasticmachine · 2024-01-24T14:42:01Z

💚 Build Succeeded

Expand to view the summary

Build stats

Duration: 9 min 4 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

chrisberkhout · 2024-01-24T14:52:27Z

I've done the following:

Accepted the changes from @shmsr.
Clarified the difference between "An old-style Oracle connection string" and "DSN configuration as a URL" (since the former won't accept URL encoding).
After @lalit-satapathy's comment, I expanded this change to cover the Oracle module documentation (shown in his screeshot) as well as the SQL module documentation. I confirmed that they both use the same DSN parsing library and aligned the overlapping content. Both now recommend DSN formats.

elasticmachine · 2024-01-25T11:09:23Z

💚 Build Succeeded

Expand to view the summary

Build stats

Start Time: 2024-01-25T11:01:03.639+0000
Duration: 8 min 14 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

elasticmachine · 2024-01-26T14:19:52Z

💚 Build Succeeded

Expand to view the summary

Build stats

Start Time: 2024-01-26T14:11:37.511+0000
Duration: 8 min 10 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

…nnection configuration.

elasticmachine · 2024-01-30T09:37:02Z

💚 Build Succeeded

Expand to view the summary

Build stats

Start Time: 2024-01-30T09:28:33.543+0000
Duration: 8 min 24 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

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

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

- Add 'oracle://' URL format. - Add note about encoding of special characters in URLs. - Align the SQL module and the Oracle module documentation.

chrisberkhout requested a review from a team as a code owner January 10, 2024 10:22

botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jan 10, 2024

chrisberkhout added enhancement Team:Security-External Integrations labels Jan 10, 2024

botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jan 10, 2024

chrisberkhout changed the title ~~Sql oracle dsn formats~~ Update SQL input documentation regarding Oracle DSNs Jan 10, 2024

mergify bot assigned chrisberkhout Jan 10, 2024

chrisberkhout mentioned this pull request Jan 10, 2024

Update SQL input documentation regarding Oracle DSNs #37582

Closed

6 tasks

chrisberkhout force-pushed the sql-oracle-dsn-formats branch from b84a41b to bdf4017 Compare January 10, 2024 10:29

chrisberkhout closed this Jan 10, 2024

chrisberkhout deleted the sql-oracle-dsn-formats branch January 10, 2024 10:34

chrisberkhout restored the sql-oracle-dsn-formats branch January 10, 2024 10:35

chrisberkhout reopened this Jan 10, 2024

agithomas self-requested a review January 10, 2024 10:55

ebeahan approved these changes Jan 23, 2024

View reviewed changes

shmsr requested changes Jan 23, 2024

View reviewed changes

metricbeat/docs/modules/sql.asciidoc Outdated Show resolved Hide resolved

metricbeat/docs/modules/sql.asciidoc Outdated Show resolved Hide resolved

chrisberkhout force-pushed the sql-oracle-dsn-formats branch from 67e2da5 to 8cc2f24 Compare January 23, 2024 19:08

chrisberkhout requested a review from shmsr January 23, 2024 19:09

chrisberkhout force-pushed the sql-oracle-dsn-formats branch from 222a60b to 210574f Compare January 24, 2024 14:30

chrisberkhout requested a review from a team as a code owner January 24, 2024 14:30

chrisberkhout requested review from a team as code owners January 24, 2024 14:30

chrisberkhout requested review from gizas, MichaelKatsoulis, ycombinator and leehinman January 24, 2024 14:30

chrisberkhout force-pushed the sql-oracle-dsn-formats branch from 210574f to 3214bb1 Compare January 24, 2024 14:32

chrisberkhout removed request for a team, ycombinator, gizas, MichaelKatsoulis and leehinman January 24, 2024 14:33

chrisberkhout changed the title ~~Update SQL input documentation regarding Oracle DSNs~~ Update SQL and Oracle module docs regarding Oracle DSNs Jan 24, 2024

chrisberkhout force-pushed the sql-oracle-dsn-formats branch from 3214bb1 to 7fb2f5f Compare January 25, 2024 11:00

chrisberkhout force-pushed the sql-oracle-dsn-formats branch from 7fb2f5f to 35b5ce7 Compare January 26, 2024 14:11

chrisberkhout mentioned this pull request Jan 30, 2024

[oracle] README updates regarding DSN formats elastic/integrations#8841

Merged

4 tasks

chrisberkhout added 2 commits January 30, 2024 10:28

Update and align the SQL and Oracle module instructions for Oracle co…

2e331b0

…nnection configuration.

Changelog update.

ccca69f

chrisberkhout force-pushed the sql-oracle-dsn-formats branch from 35b5ce7 to ccca69f Compare January 30, 2024 09:28

shmsr approved these changes Jan 30, 2024

View reviewed changes

chrisberkhout merged commit 5a9613e into elastic:main Jan 30, 2024
21 checks passed

chrisberkhout deleted the sql-oracle-dsn-formats branch January 30, 2024 09:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update SQL and Oracle module docs regarding Oracle DSNs #37590

Update SQL and Oracle module docs regarding Oracle DSNs #37590

chrisberkhout commented Jan 10, 2024 •

edited

Loading

elasticmachine commented Jan 10, 2024

mergify bot commented Jan 10, 2024

mergify bot commented Jan 10, 2024

elasticmachine commented Jan 10, 2024

Build stats

elasticmachine commented Jan 10, 2024

Build stats

`Shell Script`

elasticmachine commented Jan 10, 2024

Build stats

ebeahan left a comment

elasticmachine commented Jan 23, 2024

Build stats

elasticmachine commented Jan 23, 2024

Build stats

elasticmachine commented Jan 23, 2024

Build stats

lalit-satapathy commented Jan 24, 2024

elasticmachine commented Jan 24, 2024

Build stats

chrisberkhout commented Jan 24, 2024

elasticmachine commented Jan 25, 2024

Build stats

elasticmachine commented Jan 26, 2024

Build stats

elasticmachine commented Jan 30, 2024

Build stats

Update SQL and Oracle module docs regarding Oracle DSNs #37590

Update SQL and Oracle module docs regarding Oracle DSNs #37590

Conversation

chrisberkhout commented Jan 10, 2024 • edited Loading

Proposed commit message

Checklist

How to test this PR locally

Related issues

elasticmachine commented Jan 10, 2024

mergify bot commented Jan 10, 2024

mergify bot commented Jan 10, 2024

elasticmachine commented Jan 10, 2024

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

elasticmachine commented Jan 10, 2024

💔 Build Failed

Build stats

Steps errors

Shell Script

❕ Flaky test report

🤖 GitHub comments

elasticmachine commented Jan 10, 2024

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

ebeahan left a comment

Choose a reason for hiding this comment

elasticmachine commented Jan 23, 2024

❕ Build Aborted

Build stats

🤖 GitHub comments

elasticmachine commented Jan 23, 2024

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

elasticmachine commented Jan 23, 2024

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

lalit-satapathy commented Jan 24, 2024

elasticmachine commented Jan 24, 2024

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

chrisberkhout commented Jan 24, 2024

elasticmachine commented Jan 25, 2024

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

elasticmachine commented Jan 26, 2024

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

elasticmachine commented Jan 30, 2024

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

chrisberkhout commented Jan 10, 2024 •

edited

Loading

`Shell Script`