- Elasticsearch Guide: other versions:
- What’s new in 8.17
- Elasticsearch basics
- Quick starts
- Set up Elasticsearch
- Run Elasticsearch locally
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Miscellaneous cluster settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Data stream lifecycle settings
- Field data cache settings
- Local gateway settings
- Health Diagnostic settings
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- Inference settings
- License settings
- Machine learning settings
- Monitoring settings
- Node settings
- Networking
- Node query cache settings
- Path settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot and restore settings
- Transforms settings
- Thread pools
- Watcher settings
- Set JVM options
- Important system configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Dynamic mapping
- Explicit mapping
- Runtime fields
- Field data types
- Aggregate metric
- Alias
- Arrays
- Binary
- Boolean
- Completion
- Date
- Date nanoseconds
- Dense vector
- Flattened
- Geopoint
- Geoshape
- Histogram
- IP
- Join
- Keyword
- Nested
- Numeric
- Object
- Pass-through object
- Percolator
- Point
- Range
- Rank feature
- Rank features
- Search-as-you-type
- Semantic text
- Shape
- Sparse vector
- Text
- Token count
- Unsigned long
- Version
- Metadata fields
- Mapping parameters
analyzer
coerce
copy_to
doc_values
dynamic
eager_global_ordinals
enabled
format
ignore_above
index.mapping.ignore_above
ignore_malformed
index
index_options
index_phrases
index_prefixes
meta
fields
normalizer
norms
null_value
position_increment_gap
properties
search_analyzer
similarity
store
subobjects
term_vector
- Mapping limit settings
- Removal of mapping types
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest pipelines
- Example: Parse logs
- Enrich your data
- Processor reference
- Append
- Attachment
- Bytes
- Circle
- Community ID
- Convert
- CSV
- Date
- Date index name
- Dissect
- Dot expander
- Drop
- Enrich
- Fail
- Fingerprint
- Foreach
- Geo-grid
- GeoIP
- Grok
- Gsub
- HTML strip
- Inference
- IP Location
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Redact
- Registered domain
- Remove
- Rename
- Reroute
- Script
- Set
- Set security user
- Sort
- Split
- Terminate
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Ingest pipelines in Search
- Aliases
- Search your data
- Re-ranking
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Categorize text
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Frequent item sets
- Geo-distance
- Geohash grid
- Geohex grid
- Geotile grid
- Global
- Histogram
- IP prefix
- IP range
- Missing
- Multi Terms
- Nested
- Parent
- Random sampler
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Time series
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Average bucket
- Bucket script
- Bucket count K-S test
- Bucket correlation
- Bucket selector
- Bucket sort
- Change point
- Cumulative cardinality
- Cumulative sum
- Derivative
- Extended stats bucket
- Inference bucket
- Max bucket
- Min bucket
- Moving function
- Moving percentiles
- Normalize
- Percentiles bucket
- Serial differencing
- Stats bucket
- Sum bucket
- Bucket aggregations
- Geospatial analysis
- Connectors
- EQL
- ES|QL
- SQL
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Tutorial: Customize built-in policies
- Tutorial: Automate rollover
- Index management in Kibana
- Overview
- Concepts
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Troubleshooting index lifecycle management errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Data tiers
- Autoscaling
- Monitor a cluster
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure the Elastic Stack
- Elasticsearch security principles
- Start the Elastic Stack with security enabled automatically
- Manually configure security
- Updating node security certificates
- User authentication
- Built-in users
- Service accounts
- Internal users
- Token-based authentication services
- User profiles
- Realms
- Realm chains
- Security domains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- JWT authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Looking up users without authentication
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Role restriction
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enable audit logging
- Restricting connections with IP filtering
- Securing clients and integrations
- Operator privileges
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Watcher
- Cross-cluster replication
- Data store architecture
- REST APIs
- API conventions
- Common options
- REST API compatibility
- Autoscaling APIs
- Behavioral Analytics APIs
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat component templates
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Prevalidate node removal
- Nodes reload secure settings
- Nodes stats
- Cluster Info
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Create or update desired nodes
- Get desired nodes
- Delete desired nodes
- Get desired balance
- Reset desired balance
- Cross-cluster replication APIs
- Connector APIs
- Create connector
- Delete connector
- Get connector
- List connectors
- Update connector API key id
- Update connector configuration
- Update connector index name
- Update connector features
- Update connector filtering
- Update connector name and description
- Update connector pipeline
- Update connector scheduling
- Update connector service type
- Create connector sync job
- Cancel connector sync job
- Delete connector sync job
- Get connector sync job
- List connector sync jobs
- Check in a connector
- Update connector error
- Update connector last sync stats
- Update connector status
- Check in connector sync job
- Claim connector sync job
- Set connector sync job error
- Set connector sync job stats
- Data stream APIs
- Document APIs
- Enrich APIs
- EQL APIs
- ES|QL APIs
- Features APIs
- Fleet APIs
- Graph explore API
- Index APIs
- Alias exists
- Aliases
- Analyze
- Analyze index disk usage
- Clear cache
- Clone index
- Close index
- Create index
- Create or update alias
- Create or update component template
- Create or update index template
- Create or update index template (legacy)
- Delete component template
- Delete dangling index
- Delete alias
- Delete index
- Delete index template
- Delete index template (legacy)
- Exists
- Field usage stats
- Flush
- Force merge
- Get alias
- Get component template
- Get field mapping
- Get index
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Import dangling index
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- List dangling indices
- Open index
- Refresh
- Resolve index
- Resolve cluster
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split index
- Unfreeze index
- Update index settings
- Update mapping
- Index lifecycle management APIs
- Create or update lifecycle policy
- Get policy
- Delete policy
- Move to step
- Remove policy
- Retry policy
- Get index lifecycle management status
- Explain lifecycle
- Start index lifecycle management
- Stop index lifecycle management
- Migrate indices, ILM policies, and legacy, composable and component templates to data tiers routing
- Inference APIs
- Delete inference API
- Get inference API
- Perform inference API
- Create inference API
- Stream inference API
- Update inference API
- AlibabaCloud AI Search inference service
- Amazon Bedrock inference service
- Anthropic inference service
- Azure AI studio inference service
- Azure OpenAI inference service
- Cohere inference service
- Elasticsearch inference service
- ELSER inference service
- Google AI Studio inference service
- Google Vertex AI inference service
- HuggingFace inference service
- Mistral inference service
- OpenAI inference service
- Watsonx inference service
- Info API
- Ingest APIs
- Licensing APIs
- Logstash APIs
- Machine learning APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get model snapshots
- Get model snapshot upgrade statistics
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Reset jobs
- Revert model snapshots
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Upgrade model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Delete data frame analytics jobs
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Preview data frame analytics
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Update data frame analytics jobs
- Machine learning trained model APIs
- Clear trained model deployment cache
- Create or update trained model aliases
- Create part of a trained model
- Create trained models
- Create trained model vocabulary
- Delete trained model aliases
- Delete trained models
- Get trained models
- Get trained models stats
- Infer trained model
- Start trained model deployment
- Stop trained model deployment
- Update trained model deployment
- Migration APIs
- Node lifecycle APIs
- Query rules APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Root API
- Script APIs
- Search APIs
- Search Application APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Clear service account token caches
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Bulk create or update roles API
- Bulk delete roles API
- Create or update users
- Create service account tokens
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete service account token
- Delete users
- Disable users
- Enable users
- Enroll Kibana
- Enroll node
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Query Role
- Get service accounts
- Get service account credentials
- Get Security settings
- Get token
- Get user privileges
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- Query API key information
- Query User
- Update API key
- Update Security settings
- Bulk update API keys
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SAML complete logout
- SAML service provider metadata
- SSL certificate
- Activate user profile
- Disable user profile
- Enable user profile
- Get user profiles
- Suggest user profile
- Update user profile data
- Has privileges user profile
- Create Cross-Cluster API key
- Update Cross-Cluster API key
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- SQL APIs
- Synonyms APIs
- Text structure APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Command line tools
- elasticsearch-certgen
- elasticsearch-certutil
- elasticsearch-create-enrollment-token
- elasticsearch-croneval
- elasticsearch-keystore
- elasticsearch-node
- elasticsearch-reconfigure-node
- elasticsearch-reset-password
- elasticsearch-saml-metadata
- elasticsearch-service-tokens
- elasticsearch-setup-passwords
- elasticsearch-shard
- elasticsearch-syskeygen
- elasticsearch-users
- Optimizations
- Troubleshooting
- Fix common cluster issues
- Diagnose unassigned shards
- Add a missing tier to the system
- Allow Elasticsearch to allocate the data in the system
- Allow Elasticsearch to allocate the index
- Indices mix index allocation filters with data tiers node roles to move through data tiers
- Not enough nodes to allocate all shard replicas
- Total number of shards for an index on a single node exceeded
- Total number of shards per node has been reached
- Troubleshooting corruption
- Fix data nodes out of disk
- Fix master nodes out of disk
- Fix other role nodes out of disk
- Start index lifecycle management
- Start Snapshot Lifecycle Management
- Restore from snapshot
- Troubleshooting broken repositories
- Addressing repeated snapshot policy failures
- Troubleshooting an unstable cluster
- Troubleshooting discovery
- Troubleshooting monitoring
- Troubleshooting transforms
- Troubleshooting Watcher
- Troubleshooting searches
- Troubleshooting shards capacity health issues
- Troubleshooting an unbalanced cluster
- Capture diagnostics
- Migration guide
- Release notes
- Elasticsearch version 8.17.1
- Elasticsearch version 8.17.0
- Elasticsearch version 8.16.2
- Elasticsearch version 8.16.1
- Elasticsearch version 8.16.0
- Elasticsearch version 8.15.5
- Elasticsearch version 8.15.4
- Elasticsearch version 8.15.3
- Elasticsearch version 8.15.2
- Elasticsearch version 8.15.1
- Elasticsearch version 8.15.0
- Elasticsearch version 8.14.3
- Elasticsearch version 8.14.2
- Elasticsearch version 8.14.1
- Elasticsearch version 8.14.0
- Elasticsearch version 8.13.4
- Elasticsearch version 8.13.3
- Elasticsearch version 8.13.2
- Elasticsearch version 8.13.1
- Elasticsearch version 8.13.0
- Elasticsearch version 8.12.2
- Elasticsearch version 8.12.1
- Elasticsearch version 8.12.0
- Elasticsearch version 8.11.4
- Elasticsearch version 8.11.3
- Elasticsearch version 8.11.2
- Elasticsearch version 8.11.1
- Elasticsearch version 8.11.0
- Elasticsearch version 8.10.4
- Elasticsearch version 8.10.3
- Elasticsearch version 8.10.2
- Elasticsearch version 8.10.1
- Elasticsearch version 8.10.0
- Elasticsearch version 8.9.2
- Elasticsearch version 8.9.1
- Elasticsearch version 8.9.0
- Elasticsearch version 8.8.2
- Elasticsearch version 8.8.1
- Elasticsearch version 8.8.0
- Elasticsearch version 8.7.1
- Elasticsearch version 8.7.0
- Elasticsearch version 8.6.2
- Elasticsearch version 8.6.1
- Elasticsearch version 8.6.0
- Elasticsearch version 8.5.3
- Elasticsearch version 8.5.2
- Elasticsearch version 8.5.1
- Elasticsearch version 8.5.0
- Elasticsearch version 8.4.3
- Elasticsearch version 8.4.2
- Elasticsearch version 8.4.1
- Elasticsearch version 8.4.0
- Elasticsearch version 8.3.3
- Elasticsearch version 8.3.2
- Elasticsearch version 8.3.1
- Elasticsearch version 8.3.0
- Elasticsearch version 8.2.3
- Elasticsearch version 8.2.2
- Elasticsearch version 8.2.1
- Elasticsearch version 8.2.0
- Elasticsearch version 8.1.3
- Elasticsearch version 8.1.2
- Elasticsearch version 8.1.1
- Elasticsearch version 8.1.0
- Elasticsearch version 8.0.1
- Elasticsearch version 8.0.0
- Elasticsearch version 8.0.0-rc2
- Elasticsearch version 8.0.0-rc1
- Elasticsearch version 8.0.0-beta1
- Elasticsearch version 8.0.0-alpha2
- Elasticsearch version 8.0.0-alpha1
- Dependencies and versions
Elastic MongoDB connector reference
editElastic MongoDB connector reference
editThe Elastic MongoDB connector is a connector for MongoDB data sources. This connector is written in Python using the Elastic connector framework.
View the source code for this connector (branch 8.17, compatible with Elastic 8.17).
Elastic managed connector reference
editView Elastic managed connector reference
Availability and prerequisites
editThis connector is available as a managed connector in Elastic versions 8.5.0 and later.
To use this connector natively in Elastic Cloud, satisfy all managed connector requirements.
Compatibility
editThis connector is compatible with MongoDB Atlas and MongoDB 3.6 and later.
The data source and your Elastic deployment must be able to communicate with each other over a network.
Configuration
editEach time you create an index to be managed by this connector, you will create a new connector configuration. You will need some or all of the following information about the data source.
- Server hostname
-
The URI of the MongoDB host. Examples:
-
mongodb+srv://my_username:my_password@cluster0.mongodb.net/mydb?w=majority
-
mongodb://127.0.0.1:27017
-
- Username
-
The MongoDB username the connector will use.
The user must have access to the configured database and collection. You may want to create a dedicated, read-only user for each connector.
- Password
- The MongoDB password the connector will use.
- Database
- The MongoDB database to sync. The database must be accessible using the configured username and password.
- Collection
- The MongoDB collection to sync. The collection must exist within the configured database. The collection must be accessible using the configured username and password.
- Direct connection
- Toggle to use the direct connection option for the MongoDB client. Disabled by default.
- SSL/TLS Connection
-
Toggle to establish a secure connection to the MongoDB server using SSL/TLS encryption. Ensure that your MongoDB deployment supports SSL/TLS connections. Enable if your MongoDB cluster uses DNS SRV records (namely MongoDB Atlas users).
Disabled by default.
- Certificate Authority (.pem)
- Specifies the root certificate from the Certificate Authority. The value of the certificate is used to validate the certificate presented by the MongoDB instance.
Atlas users can leave this blank because Atlas uses a widely trusted root CA.
- Skip certificate verification
- Skips various certificate validations (if SSL is enabled). Disabled by default.
We strongly recommend leaving this option disabled in production environments.
Create a MongoDB connector
editUse the UI
editTo create a new MongoDB connector:
- In the Kibana UI, navigate to the Search → Content → Connectors page from the main menu, or use the global search field.
- Follow the instructions to create a new native MongoDB connector.
For additional operations, see Connectors UI in Kibana.
Use the API
editYou can use the Elasticsearch Create connector API to create a new native MongoDB connector.
For example:
resp = client.connector.put( connector_id="my-{service-name-stub}-connector", index_name="my-elasticsearch-index", name="Content synced from {service-name}", service_type="{service-name-stub}", is_native=True, ) print(resp)
const response = await client.connector.put({ connector_id: "my-{service-name-stub}-connector", index_name: "my-elasticsearch-index", name: "Content synced from {service-name}", service_type: "{service-name-stub}", is_native: true, }); console.log(response);
PUT _connector/my-mongodb-connector { "index_name": "my-elasticsearch-index", "name": "Content synced from MongoDB", "service_type": "mongodb", "is_native": true }
You’ll also need to create an API key for the connector to use.
The user needs the cluster privileges manage_api_key
, manage_connector
and write_connector_secrets
to generate API keys programmatically.
To create an API key for the connector:
-
Run the following command, replacing values where indicated. Note the
id
andencoded
return values from the response:resp = client.security.create_api_key( name="my-connector-api-key", role_descriptors={ "my-connector-connector-role": { "cluster": [ "monitor", "manage_connector" ], "indices": [ { "names": [ "my-index_name", ".search-acl-filter-my-index_name", ".elastic-connectors*" ], "privileges": [ "all" ], "allow_restricted_indices": False } ] } }, ) print(resp)
const response = await client.security.createApiKey({ name: "my-connector-api-key", role_descriptors: { "my-connector-connector-role": { cluster: ["monitor", "manage_connector"], indices: [ { names: [ "my-index_name", ".search-acl-filter-my-index_name", ".elastic-connectors*", ], privileges: ["all"], allow_restricted_indices: false, }, ], }, }, }); console.log(response);
POST /_security/api_key { "name": "my-connector-api-key", "role_descriptors": { "my-connector-connector-role": { "cluster": [ "monitor", "manage_connector" ], "indices": [ { "names": [ "my-index_name", ".search-acl-filter-my-index_name", ".elastic-connectors*" ], "privileges": [ "all" ], "allow_restricted_indices": false } ] } } }
-
Use the
encoded
value to store a connector secret, and note theid
return value from this response:resp = client.perform_request( "POST", "/_connector/_secret", headers={"Content-Type": "application/json"}, body={ "value": "encoded_api_key" }, ) print(resp)
const response = await client.transport.request({ method: "POST", path: "/_connector/_secret", body: { value: "encoded_api_key", }, }); console.log(response);
POST _connector/_secret { "value": "encoded_api_key" }
-
Use the API key
id
and the connector secretid
to update the connector:resp = client.connector.update_api_key_id( connector_id="my_connector_id>", api_key_id="API key_id", api_key_secret_id="secret_id", ) print(resp)
const response = await client.connector.updateApiKeyId({ connector_id: "my_connector_id>", api_key_id: "API key_id", api_key_secret_id: "secret_id", }); console.log(response);
PUT /_connector/my_connector_id>/_api_key_id { "api_key_id": "API key_id", "api_key_secret_id": "secret_id" }
Refer to the Elasticsearch API documentation for details of all available Connector APIs.
Usage
editTo use this connector as a managed connector, use the Connector workflow. See Elastic managed connectors.
For additional operations, see Connectors UI in Kibana.
Example
editAn example is available for this connector. See Managed connector tutorial (MongoDB).
Known issues
editSSL must be enabled for MongoDB Atlas
edit-
A bug introduced in 8.12.0 causes the connector to fail to sync Mongo Atlas urls (
mongo+srv
) unless SSL/TLS is enabled.
Expressions and variables in aggregation pipelines
editIt’s not possible to use expressions like new Date()
inside an aggregation pipeline.
These expressions won’t be evaluated by the underlying MongoDB client, but will be passed as a string to the MongoDB instance.
A possible workaround is to use aggregation variables.
Incorrect (new Date()
will be interpreted as string):
{ "aggregate": { "pipeline": [ { "$match": { "expiresAt": { "$gte": "new Date()" } } } ] } }
Correct (usage of $$NOW):
{ "aggregate": { "pipeline": [ { "$addFields": { "current_date": { "$toDate": "$$NOW" } } }, { "$match": { "$expr": { "$gte": [ "$expiresAt", "$current_date" ] } } } ] } }
Connecting with self-signed or custom CA TLS Cert
editCurrently, the MongoDB connector does not support working with self-signed or custom CA certs when connecting to your self-managed MongoDB host.
The following workaround should not be used in production.
This can be worked around in development environments, by appending certain query parameters to the configured host.
For example, if your host is mongodb+srv://my.mongo.host.com
, appending ?tls=true&tlsAllowInvalidCertificates=true
will allow disabling TLS certificate verification.
The full host in this example will look like this:
mongodb+srv://my.mongo.host.com/?tls=true&tlsAllowInvalidCertificates=true
See Known issues for any issues affecting all connectors.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.
Documents and syncs
editThe following describes the default syncing behavior for this connector. Use sync rules and ingest pipelines to customize syncing for specific indices.
All documents in the configured MongoDB database and collection are extracted and transformed into documents in your Elasticsearch index.
- The connector creates one Elasticsearch document for each MongoDB document in the configured database and collection.
- For each document, the connector transforms each MongoDB field into an Elasticsearch field.
- For each field, Elasticsearch dynamically determines the data type.
This results in Elasticsearch documents that closely match the original MongoDB documents.
The Elasticsearch mapping is created when the first document is created.
Each sync is a "full" sync. For each MongoDB document discovered:
- If it does not exist, the document is created in Elasticsearch.
- If it already exists in Elasticsearch, the Elasticsearch document is replaced and the version is incremented.
- If an existing Elasticsearch document no longer exists in the MongoDB collection, it is deleted from Elasticsearch.
-
Embedded documents are stored as an
object
field in the parent document.
This is recursive, because embedded documents can themselves contain embedded documents.
- Files bigger than 10 MB won’t be extracted
- Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
Sync rules
editThe following sections describe Sync rules for this connector.
Basic sync rules are identical for all connectors and are available by default.
Advanced rules for MongoDB can be used to express either find
queries or aggregation pipelines.
They can also be used to tune options available when issuing these queries/pipelines.
find
queries
editYou must create a text index on the MongoDB collection in order to perform text searches.
For find
queries, the structure of this JSON DSL should look like:
{ "find":{ "filter": { // find query goes here }, "options":{ // query options go here } } }
For example:
{ "find": { "filter": { "$text": { "$search": "garden", "$caseSensitive": false } }, "skip": 10, "limit": 1000 } }
find
queries also support additional options, for example the projection
object:
{ "find": { "filter": { "languages": [ "English" ], "runtime": { "$gt":90 } }, "projection":{ "tomatoes": 1 } } }
Where the available options are:
-
allow_disk_use
(true, false) — When set to true, the server can write temporary data to disk while executing the find operation. This option is only available on MongoDB server versions 4.4 and newer. -
allow_partial_results
(true, false) — Allows the query to get partial results if some shards are down. -
batch_size
(Integer) — The number of documents returned in each batch of results from MongoDB. -
filter
(Object) — The filter criteria for the query. -
limit
(Integer) — The max number of docs to return from the query. -
max_time_ms
(Integer) — The maximum amount of time to allow the query to run, in milliseconds. -
no_cursor_timeout
(true, false) — The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that. -
projection
(Array, Object) — The fields to include or exclude from each doc in the result set. If an array, it should have at least one item. -
return_key
(true, false) — Return index keys rather than the documents. -
show_record_id
(true, false) — Return the$recordId
for each doc in the result set. -
skip
(Integer) — The number of docs to skip before returning results.
Aggregation pipelines
editSimilarly, for aggregation pipelines, the structure of the JSON DSL should look like:
{ "aggregate":{ "pipeline": [ // pipeline elements go here ], "options": { // pipeline options go here } } }
Where the available options are:
-
allowDiskUse
(true, false) — Set to true if disk usage is allowed during the aggregation. -
batchSize
(Integer) — The number of documents to return per batch. -
bypassDocumentValidation
(true, false) — Whether or not to skip document level validation. -
collation
(Object) — The collation to use. -
comment
(String) — A user-provided comment to attach to this command. -
hint
(String) — The index to use for the aggregation. -
let
(Object) — Mapping of variables to use in the pipeline. See the server documentation for details. -
maxTimeMs
(Integer) — The maximum amount of time in milliseconds to allow the aggregation to run.
Migrating from the Ruby connector framework
editAs part of the 8.8.0 release the MongoDB connector was moved from the Ruby connectors framework to the Elastic connector framework.
This change introduces minor formatting modifications to data ingested from MongoDB:
- Nested object id field name has changed from "_id" to "id". For example, if you had a field "customer._id", this will now be named "customer.id".
-
Date format has changed from
YYYY-MM-DD'T'HH:mm:ss.fff'Z'
toYYYY-MM-DD'T'HH:mm:ss
If your MongoDB connector stopped working after migrating from 8.7.x to 8.8.x, read the workaround outlined in Known issues. If that does not work, we recommend deleting the search index attached to this connector and re-creating a MongoDB connector from scratch.
Self-managed connector
editView self-managed connector reference
Availability and prerequisites
editThis connector is also available as a self-managed connector from the Elastic connector framework. To use this connector as a self-managed connector, satisfy all self-managed connector requirements.
Compatibility
editThis connector is compatible with MongoDB Atlas and MongoDB 3.6 and later.
The data source and your Elastic deployment must be able to communicate with each other over a network.
Configuration
editWhen using the self-managed connector workflow, initially these fields will use the default configuration set in the connector source code.
These are set in the get_default_configuration
function definition.
These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.
The following configuration fields are required to set up the connector:
-
host
-
The URI of the MongoDB host. Examples:
-
mongodb+srv://my_username:my_password@cluster0.mongodb.net/mydb?w=majority
-
mongodb://127.0.0.1:27017
-
-
user
-
The MongoDB username the connector will use.
The user must have access to the configured database and collection. You may want to create a dedicated, read-only user for each connector.
-
password
- The MongoDB password the connector will use.
Anonymous authentication is supported for testing purposes only, but should not be used in production. Omit the username and password, to use default values.
-
database
- The MongoDB database to sync. The database must be accessible using the configured username and password.
-
collection
- The MongoDB collection to sync. The collection must exist within the configured database. The collection must be accessible using the configured username and password.
-
direct_connection
-
Whether to use the direct connection option for the MongoDB client.
Default value is
False
. -
ssl_enabled
-
Whether to establish a secure connection to the MongoDB server using SSL/TLS encryption. Ensure that your MongoDB deployment supports SSL/TLS connections. Enable if your MongoDB cluster uses DNS SRV records (namely MongoDB Atlas users).
Default value is
False
. -
ssl_ca
- Specifies the root certificate from the Certificate Authority. The value of the certificate is used to validate the certificate presented by the MongoDB instance.
Atlas users can leave this blank because Atlas uses a widely trusted root CA.
-
tls_insecure
-
Skips various certificate validations (if SSL is enabled).
Default value is
False
.
We strongly recommend leaving this option disabled in production environments.
Create a MongoDB connector
editUse the UI
editTo create a new MongoDB connector:
- In the Kibana UI, navigate to the Search → Content → Connectors page from the main menu, or use the global search field.
- Follow the instructions to create a new MongoDB self-managed connector.
Use the API
editYou can use the Elasticsearch Create connector API to create a new self-managed MongoDB self-managed connector.
For example:
resp = client.connector.put( connector_id="my-{service-name-stub}-connector", index_name="my-elasticsearch-index", name="Content synced from {service-name}", service_type="{service-name-stub}", ) print(resp)
const response = await client.connector.put({ connector_id: "my-{service-name-stub}-connector", index_name: "my-elasticsearch-index", name: "Content synced from {service-name}", service_type: "{service-name-stub}", }); console.log(response);
PUT _connector/my-mongodb-connector { "index_name": "my-elasticsearch-index", "name": "Content synced from MongoDB", "service_type": "mongodb" }
You’ll also need to create an API key for the connector to use.
The user needs the cluster privileges manage_api_key
, manage_connector
and write_connector_secrets
to generate API keys programmatically.
To create an API key for the connector:
-
Run the following command, replacing values where indicated. Note the
encoded
return values from the response:resp = client.security.create_api_key( name="connector_name-connector-api-key", role_descriptors={ "connector_name-connector-role": { "cluster": [ "monitor", "manage_connector" ], "indices": [ { "names": [ "index_name", ".search-acl-filter-index_name", ".elastic-connectors*" ], "privileges": [ "all" ], "allow_restricted_indices": False } ] } }, ) print(resp)
const response = await client.security.createApiKey({ name: "connector_name-connector-api-key", role_descriptors: { "connector_name-connector-role": { cluster: ["monitor", "manage_connector"], indices: [ { names: [ "index_name", ".search-acl-filter-index_name", ".elastic-connectors*", ], privileges: ["all"], allow_restricted_indices: false, }, ], }, }, }); console.log(response);
POST /_security/api_key { "name": "connector_name-connector-api-key", "role_descriptors": { "connector_name-connector-role": { "cluster": [ "monitor", "manage_connector" ], "indices": [ { "names": [ "index_name", ".search-acl-filter-index_name", ".elastic-connectors*" ], "privileges": [ "all" ], "allow_restricted_indices": false } ] } } }
-
Update your
config.yml
file with the API keyencoded
value.
Refer to the Elasticsearch API documentation for details of all available Connector APIs.
Usage
editTo use this connector as a self-managed connector, see Self-managed connectors For additional usage operations, see Connectors UI in Kibana.
Example
editAn example is available for this connector. See Managed connector tutorial (MongoDB).
Known issues
editSSL must be enabled for MongoDB Atlas
edit-
A bug introduced in 8.12.0 causes the connector to fail to sync Mongo Atlas urls (
mongo+srv
) unless SSL/TLS is enabled.
Expressions and variables in aggregation pipelines
editIt’s not possible to use expressions like new Date()
inside an aggregation pipeline.
These expressions won’t be evaluated by the underlying MongoDB client, but will be passed as a string to the MongoDB instance.
A possible workaround is to use aggregation variables.
Incorrect (new Date()
will be interpreted as string):
{ "aggregate": { "pipeline": [ { "$match": { "expiresAt": { "$gte": "new Date()" } } } ] } }
Correct (usage of $$NOW):
{ "aggregate": { "pipeline": [ { "$addFields": { "current_date": { "$toDate": "$$NOW" } } }, { "$match": { "$expr": { "$gte": [ "$expiresAt", "$current_date" ] } } } ] } }
Connecting with self-signed or custom CA TLS Cert
editCurrently, the MongoDB connector does not support working with self-signed or custom CA certs when connecting to your self-managed MongoDB host.
The following workaround should not be used in production.
This can be worked around in development environments, by appending certain query parameters to the configured host.
For example, if your host is mongodb+srv://my.mongo.host.com
, appending ?tls=true&tlsAllowInvalidCertificates=true
will allow disabling TLS certificate verification.
The full host in this example will look like this:
mongodb+srv://my.mongo.host.com/?tls=true&tlsAllowInvalidCertificates=true
Docker image errors out for versions 8.12.0 and 8.12.1
editA bug introduced in 8.12.0 causes the Connectors docker image to error out if run using MongoDB as its source.
The command line will output the error cannot import name 'coroutine' from 'asyncio'
.
This issue is fixed in versions 8.12.2 and 8.13.0.
This bug does not affect Elastic managed connectors.
See Known issues for any issues affecting all connectors.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.
Deployment using Docker
editYou can deploy the MongoDB connector as a self-managed connector using Docker. Follow these instructions.
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/main/config.yml.example --output ~/connectors-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:
-
elasticsearch.host
-
elasticsearch.api_key
-
connectors
If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:
# When connecting to your cloud deployment you should edit the host value elasticsearch.host: http://host.docker.internal:9200 elasticsearch.api_key: <ELASTICSEARCH_API_KEY> connectors: - connector_id: <CONNECTOR_ID_FROM_KIBANA> service_type: mongodb api_key: <CONNECTOR_API_KEY_FROM_KIBANA> # Optional. If not provided, the connector will use the elasticsearch.api_key instead
Using the elasticsearch.api_key
is the recommended authentication method. However, you can also use elasticsearch.username
and elasticsearch.password
to authenticate with your Elasticsearch instance.
Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.
Step 3: Run the Docker image
Run the Docker image with the Connector Service using the following command:
docker run \ -v ~/connectors-config:/config \ --network "elastic" \ --tty \ --rm \ docker.elastic.co/enterprise-search/elastic-connectors:8.17.0.0 \ /app/bin/elastic-ingest \ -c /config/config.yml
Refer to DOCKER.md
in the elastic/connectors
repo for more details.
Find all available Docker images in the official registry.
We also have a quickstart self-managed option using Docker Compose, so you can spin up all required services at once: Elasticsearch, Kibana, and the connectors service.
Refer to this README in the elastic/connectors
repo for more information.
Documents and syncs
editThe following describes the default syncing behavior for this connector. Use sync rules and ingest pipelines to customize syncing for specific indices.
All documents in the configured MongoDB database and collection are extracted and transformed into documents in your Elasticsearch index.
- The connector creates one Elasticsearch document for each MongoDB document in the configured database and collection.
- For each document, the connector transforms each MongoDB field into an Elasticsearch field.
- For each field, Elasticsearch dynamically determines the data type.
This results in Elasticsearch documents that closely match the original MongoDB documents.
The Elasticsearch mapping is created when the first document is created.
Each sync is a "full" sync. For each MongoDB document discovered:
- If it does not exist, the document is created in Elasticsearch.
- If it already exists in Elasticsearch, the Elasticsearch document is replaced and the version is incremented.
- If an existing Elasticsearch document no longer exists in the MongoDB collection, it is deleted from Elasticsearch.
-
Embedded documents are stored as an
object
field in the parent document.
This is recursive, because embedded documents can themselves contain embedded documents.
- Files bigger than 10 MB won’t be extracted
- Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
Sync rules
editThe following sections describe Sync rules for this connector.
Basic sync rules are identical for all connectors and are available by default.
Advanced rules for MongoDB can be used to express either find
queries or aggregation pipelines.
They can also be used to tune options available when issuing these queries/pipelines.
find
queries
editYou must create a text index on the MongoDB collection in order to perform text searches.
For find
queries, the structure of this JSON DSL should look like:
{ "find":{ "filter": { // find query goes here }, "options":{ // query options go here } } }
For example:
{ "find": { "filter": { "$text": { "$search": "garden", "$caseSensitive": false } }, "skip": 10, "limit": 1000 } }
find
queries also support additional options, for example the projection
object:
{ "find": { "filter": { "languages": [ "English" ], "runtime": { "$gt":90 } }, "projection":{ "tomatoes": 1 } } }
Where the available options are:
-
allow_disk_use
(true, false) — When set to true, the server can write temporary data to disk while executing the find operation. This option is only available on MongoDB server versions 4.4 and newer. -
allow_partial_results
(true, false) — Allows the query to get partial results if some shards are down. -
batch_size
(Integer) — The number of documents returned in each batch of results from MongoDB. -
filter
(Object) — The filter criteria for the query. -
limit
(Integer) — The max number of docs to return from the query. -
max_time_ms
(Integer) — The maximum amount of time to allow the query to run, in milliseconds. -
no_cursor_timeout
(true, false) — The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that. -
projection
(Array, Object) — The fields to include or exclude from each doc in the result set. If an array, it should have at least one item. -
return_key
(true, false) — Return index keys rather than the documents. -
show_record_id
(true, false) — Return the$recordId
for each doc in the result set. -
skip
(Integer) — The number of docs to skip before returning results.
Aggregation pipelines
editSimilarly, for aggregation pipelines, the structure of the JSON DSL should look like:
{ "aggregate":{ "pipeline": [ // pipeline elements go here ], "options": { // pipeline options go here } } }
Where the available options are:
-
allowDiskUse
(true, false) — Set to true if disk usage is allowed during the aggregation. -
batchSize
(Integer) — The number of documents to return per batch. -
bypassDocumentValidation
(true, false) — Whether or not to skip document level validation. -
collation
(Object) — The collation to use. -
comment
(String) — A user-provided comment to attach to this command. -
hint
(String) — The index to use for the aggregation. -
let
(Object) — Mapping of variables to use in the pipeline. See the server documentation for details. -
maxTimeMs
(Integer) — The maximum amount of time in milliseconds to allow the aggregation to run.
Migrating from the Ruby connector framework
editAs part of the 8.8.0 release the MongoDB connector was moved from the Ruby connectors framework to the Elastic connector framework.
This change introduces minor formatting modifications to data ingested from MongoDB:
- Nested object id field name has changed from "_id" to "id". For example, if you had a field "customer._id", this will now be named "customer.id".
-
Date format has changed from
YYYY-MM-DD'T'HH:mm:ss.fff'Z'
toYYYY-MM-DD'T'HH:mm:ss
If your MongoDB connector stopped working after migrating from 8.7.x to 8.8.x, read the workaround outlined in Known issues. If that does not work, we recommend deleting the search index attached to this connector and re-creating a MongoDB connector from scratch.
On this page
- Elastic managed connector reference
- Availability and prerequisites
- Compatibility
- Configuration
- Create a MongoDB connector
- Use the UI
- Use the API
- Usage
- Example
- Known issues
- SSL must be enabled for MongoDB Atlas
- Expressions and variables in aggregation pipelines
- Connecting with self-signed or custom CA TLS Cert
- Troubleshooting
- Security
- Documents and syncs
- Sync rules
find
queries- Aggregation pipelines
- Migrating from the Ruby connector framework
- Self-managed connector
- Availability and prerequisites
- Compatibility
- Configuration
- Create a MongoDB connector
- Use the UI
- Use the API
- Usage
- Example
- Known issues
- SSL must be enabled for MongoDB Atlas
- Expressions and variables in aggregation pipelines
- Connecting with self-signed or custom CA TLS Cert
- Docker image errors out for versions 8.12.0 and 8.12.1
- Troubleshooting
- Security
- Deployment using Docker
- Documents and syncs
- Sync rules
find
queries- Aggregation pipelines
- Migrating from the Ruby connector framework