Skip to content

Commit 96951f4

Browse files
[oracle] README updates regarding DSN formats (#8841)
- Remove unsupported DSN format. - Add note about URL encoding special characters. - Add logfmt-encoded DSN format.
1 parent d9a382d commit 96951f4

File tree

4 files changed

+39
-14
lines changed

4 files changed

+39
-14
lines changed

packages/oracle/_dev/build/docs/README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,23 @@ Then, Metricbeat can be launched.
6262

6363
### Oracle DSN Configuration
6464

65-
The supported configuration takes one of the forms
66-
- `oracle://<user>:<password>@<connection_string>`
67-
- `<user>:<password>@<connection_string>`
68-
69-
Examples of supported configurations are as below:
70-
- `oracle://sys:Oradoc_db1@0.0.0.0:1521/ORCLCDB.localdomain?sysdba=1`
71-
- `sys:Oradoc_db1@0.0.0.0:1521/ORCLCDB.localdomain?sysdba=1`
65+
The following two configuration formats are supported:
66+
```
67+
oracle://<user>:<password>@<connection_string>
68+
user="<user>" password="<password>" connectString="<connection_string>" sysdba=<true|false>
69+
```
70+
71+
Example values are:
72+
```
73+
oracle://sys:Oradoc_db1@0.0.0.0:1521/ORCLCDB.localdomain?sysdba=1
74+
user="sys" password="Oradoc_db1" connectString="0.0.0.0:1521/ORCLCDB.localdomain" sysdba=true
75+
```
76+
77+
In the first, URL-based format, special characters should be URL encoded.
78+
79+
In the seoncd, logfmt-encoded DSN format, if the password contains a backslash
80+
character (`\`), it must be escaped with another backslash. For example, if the
81+
password is `my\_password`, it must be written as `my\\_password`.
7282

7383
## Compatibility
7484

packages/oracle/changelog.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# newer versions go on top
2+
- version: 1.24.2
3+
changes:
4+
- description: README updates regarding DSN formats.
5+
type: bugfix
6+
link: https://github.com/elastic/integrations/pull/8841
27
- version: 1.24.1
38
changes:
49
- description: Make Oracle DSN configuration details more discoverable.

packages/oracle/docs/README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,23 @@ Then, Metricbeat can be launched.
6262

6363
### Oracle DSN Configuration
6464

65-
The supported configuration takes one of the forms
66-
- `oracle://<user>:<password>@<connection_string>`
67-
- `<user>:<password>@<connection_string>`
65+
The following two configuration formats are supported:
66+
```
67+
oracle://<user>:<password>@<connection_string>
68+
user="<user>" password="<password>" connectString="<connection_string>" sysdba=<true|false>
69+
```
70+
71+
Example values are:
72+
```
73+
oracle://sys:Oradoc_db1@0.0.0.0:1521/ORCLCDB.localdomain?sysdba=1
74+
user="sys" password="Oradoc_db1" connectString="0.0.0.0:1521/ORCLCDB.localdomain" sysdba=true
75+
```
76+
77+
In the first, URL-based format, special characters should be URL encoded.
6878

69-
Examples of supported configurations are as below:
70-
- `oracle://sys:Oradoc_db1@0.0.0.0:1521/ORCLCDB.localdomain?sysdba=1`
71-
- `sys:Oradoc_db1@0.0.0.0:1521/ORCLCDB.localdomain?sysdba=1`
79+
In the seoncd, logfmt-encoded DSN format, if the password contains a backslash
80+
character (`\`), it must be escaped with another backslash. For example, if the
81+
password is `my\_password`, it must be written as `my\\_password`.
7282

7383
## Compatibility
7484

packages/oracle/manifest.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
format_version: "3.0.0"
22
name: oracle
33
title: "Oracle"
4-
version: "1.24.1"
4+
version: "1.24.2"
55
description: Collect Oracle Audit Log, Performance metrics, Tablespace metrics, Sysmetrics metrics, System statistics metrics, memory metrics from Oracle database.
66
type: integration
77
categories:

0 commit comments

Comments
 (0)