Availability and prerequisitesedit
This connector is available as a connector client from the Python connectors framework. This connector client is compatible with Elastic versions 8.6.0+. To use this connector, satisfy all connector client requirements.
This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
To use this connector as a connector client, see Connector clients and frameworks.
The database user requires
DBA privileges and must be the owner of the tables to be indexed.
To set up a secure connection the Oracle service must be installed on the system where the connector is running.
Follow these steps:
oracle_homeparameter to your Oracle home directory. If configuration files are not at the default location, set the
Create a directory to store the wallet.
$ mkdir $ORACLE_HOME/ssl_wallet
Create file named
$ORACLE_HOME/network/adminand add the following content:
WALLET_LOCATION = (SOURCE = (METHOD = FILE) (METHOD_DATA = (DIRECTORY = $ORACLE_HOME/ssl_wallet))) SSL_CLIENT_AUTHENTICATION = FALSE SSL_VERSION = 1.0 SSL_CIPHER_SUITES = (SSL_RSA_WITH_AES_256_CBC_SHA) SSL_SERVER_DN_MATCH = ON
Run the following commands to create a wallet and attach an SSL certificate. Replace the file name with your file name.
$ orapki wallet create -wallet path-to-oracle-home/ssl_wallet -auto_login_only $ orapki wallet add -wallet path-to-oracle-home/ssl_wallet -trusted_cert -cert path-to-oracle-home/ssl_wallet/root_ca.pem -auto_login_only
For more information, refer to this Amazon RDS documentation about Oracle SSL. Oracle docs: https://docs.oracle.com/database/121/DBSEG/asossl.htm#DBSEG070.
For additional operations, see Usage.
Oracle Database versions 18c, 19c and 21c are compatible with Elastic connector frameworks.
When using the connector client workflow, these fields will use the default configuration set in the connector source code.
Note that this data source uses the
generic_database.py connector source code.
oracle.py for additional code, specific to this data source.
These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, users will be able to update these values in Kibana.
The following configuration fields are required to set up the connector:
The IP address or hostname of the Oracle database server.
Default value is
Port number of the Oracle database server. Default value is
The protocol which the connector uses to establish a connection. Default value is
TCP. For secured connections, a user needs to use
Path of the Oracle home directory to run connector with thick mode for secured connection. By default connector will run on Thin Mode. For unsecured connections, keep this field empty.
Path of the oracle configuration files. Only applicable when configuration files are not at the default location. By default files are located at
$ORACLE_HOME/network/admin. Keep this field empty unless files are not at default location.
- Username to use to connect to the Oracle database server.
- Password to use to connect to the Oracle database server.
- SID of the Oracle database to connect to.
Comma-separated list of tables to monitor for changes. Default value is
Number of rows to fetch per request.
Default value is
Number of retry attempts after failed request to Oracle Database.
Default value is
Protocol which the connector uses to establish a connection.
Default value is
TCP. For secure connections, use
- Path of the Oracle home directory to run connector in thick mode for secured connection. For unsecured connections, keep this field empty.
- Path of Oracle configuration files. Only applicable when configuration files are not at the default location. If files are located at the default location, keep this field empty.
Deployment using Dockeredit
Follow these instructions to deploy the Oracle connector using Docker.
Step 1: Download sample configuration file
Download the sample configuration file. You can either download it manually or run the following command:
curl https://raw.githubusercontent.com/elastic/connectors-python/main/config.yml --output ~/connectors-python-config/config.yml
Remember to update the
--output argument value if your directory name is different, or you want to use a different config file name.
Step 2: Update the configuration file for your self-managed connector
Update the configuration file with the following settings to match your environment:
Use oracle as the
Don’t forget to uncomment "oracle" in the
sources section of the
If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:
elasticsearch: host: http://host.docker.internal:9200 username: elastic password: <YOUR_PASSWORD> connector_id: <CONNECTOR_ID_FROM_KIBANA> service_type: oracle sources: # UNCOMMENT "oracle" below to enable the Oracle connector #mongodb: connectors.sources.mongo:MongoDataSource #s3: connectors.sources.s3:S3DataSource #dir: connectors.sources.directory:DirectoryDataSource #mysql: connectors.sources.mysql:MySqlDataSource #network_drive: connectors.sources.network_drive:NASDataSource #google_cloud_storage: connectors.sources.google_cloud_storage:GoogleCloudStorageDataSource #azure_blob_storage: connectors.sources.azure_blob_storage:AzureBlobStorageDataSource #postgresql: connectors.sources.postgresql:PostgreSQLDataSource #oracle: connectors.sources.oracle:OracleDataSource #mssql: connectors.sources.mssql:MSSQLDataSource
Note that the config file you downloaded might contain more entries, so you will need to manually copy/change the settings that apply to you.
Normally you’ll only need to update
service_type to run the connector service.
Step 3: Run the Docker image
Run the Docker image with the Connector Service using the following command:
docker run \ -v ~/connectors-python-config:/config \ --network "elastic" \ --tty \ --rm \ docker.elastic.co/enterprise-search/elastic-connectors:18.104.22.168-SNAPSHOT \ /app/bin/elastic-ingest \ -c /config/config.yml
Refer to this guide in the Python framework repository for more details.
Documents and syncsedit
- Files bigger than 10 MB won’t be extracted.
- Tables with no primary key defined are skipped.
If the table’s system change number (SCN) value is not between the
max(SCN)values of the
SMON_SCN_TIMEtable, the connector will not be able to retrieve the most recently updated time. Data will therefore index in every sync. For more details refer to the following discussion thread.
sysuser is not supported, as it contains 1000+ system tables. If you need to work with the
sysuser, use either
sysoperand configure this as the username.
- Permissions are not synced.
- Filtering rules are not available in the current version, because filtering is controlled by ingest pipelines.
See Content extraction.
Connector client operationsedit
The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.
To execute a functional test for the Oracle connector, run the following command:
make ftest NAME=oracle
By default, this will use a medium-sized dataset.
To make the test faster add the
make ftest NAME=oracle DATA_SIZE=small
There are no known issues for this connector.
See Known issues for any issues affecting all connectors.
Framework and sourceedit
This connector is included in the Python connectors framework.
This connector uses the generic database connector source code (branch 8.8, compatible with Elastic 8.8).
View additional code specific to this data source (branch 8.8, compatible with Elastic 8.8).
Intro to Kibana
ELK for Logs & Metrics