[oracle] README updates regarding DSN formats

[chrisberkhout]

Proposed commit message

[oracle] README updates regarding DSN formats (#8841)

- Remove unsupported DSN format.
- Add note about URL encoding special characters.
- Add logfmt-encoded DSN format.

Discussion

The oracle integration uses Filebeat's sql input. That uses the GO DRiver for ORacle DB to parse Oracle DSNs. When supplied with the removed format, it parses the joined username and password as only a username, with no password, as demonstrated by the following script.

DSN parsing script

Script:

package main

import (
	"fmt"

	"github.com/godror/godror"
)

func main() {
	params, err := godror.ParseDSN("sys:Oradoc_db1@0.0.0.0:1521/ORCLCDB.localdomain?sysdba=1")
	if err != nil {
		fmt.Println(err)
	} else {
		fmt.Println(params.Username)
		fmt.Println(params.Password.Secret())
	}
}

Output:

sys:Oradoc_db1

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.

[elasticmachine]

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

[elasticmachine]

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

[ebeahan]

LGTM.

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

[chrisberkhout]

/test

[agithomas]

@chrisberkhout, apologies for the delayed review. There was a related Oracle Integration issue related to the DSN format, which is now resolved, following user testing and confirmation.

This new DSN format has been available since ES version 8.7.

An example of the new format is

user="sys" password="Oradoc_db1" connectString="0.0.0.0:1521/ORCLCDB.localdomain" sysdba=true

Reference: https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-module-oracle.html

Would you like to consider including this format as part of this PR?

[chrisberkhout]

Hi @agithomas, no worries, I've added that 2nd format.

This Oracle integration actually uses the SQL input, not the Oracle input. However, those inputs both use the same library for parsing DSNs.

I update the documentation for both of the inputs in elastic/beats#37590. These PRs are an attempt to clean up the documentation following a user problem with escaping while using an oracle:// URL.

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: db282bf

History

• 💚 Build #8309 succeeded 42d2e6a31f323cef80dfd05701e2cc07c5359b4f
• 💔 Build #8304 failed fe40a56313310bc5f73e394a4dae888531aa8d27
• 💔 Build #8301 failed fe40a56313310bc5f73e394a4dae888531aa8d27

cc @chrisberkhout

[agithomas]

I have tested both with

• sysdba=false
• without sysdba=false

both works Ok

[agithomas]

LGTM!

[elasticmachine]

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