- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 7.12
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Development tools settings
- Graph settings
- Fleet settings
- i18n settings
- Logs settings
- Metrics settings
- Machine learning settings
- Monitoring settings
- Reporting settings
- Secure settings
- Search sessions settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Embed Kibana content in a web page
- Configure monitoring
- Configure security
- Production considerations
- Discover
- Dashboard
- Canvas
- Maps
- Machine learning
- Graph
- Observability
- APM
- Elastic Security
- Dev Tools
- Stack Monitoring
- Stack Management
- Fleet
- Reporting
- Alerting and Actions
- REST API
- Kibana plugins
- Accessibility
- Release notes
- Developer guide
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Index action
editIndex action
editThe index action type will index a document into Elasticsearch. See also the create index API.
Connector configuration
editIndex connectors have the following configuration properties.
- Name
- The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
- Index
- The Elasticsearch index to be written to.
- Refresh
- Setting for the refresh policy for the write request.
- Execution time field
- This field will be automatically set to the time the alert condition was detected.
Preconfigured action type
editmy-index: name: action-type-index actionTypeId: .index config: index: .kibana refresh: true executionTimeField: somedate
Config defines information for the action type.
-
index
- A string that corresponds to Index.
-
refresh
-
A boolean that corresponds to Refresh. Defaults to
false
. -
executionTimeField
- A string that corresponds to Execution time field.
Action configuration
editIndex actions have the following properties.
- Document
- The document to index in JSON format.
Example
editExample of the index document for Index Threshold alert:
{ "alert_id": "{{alertId}}", "alert_name": "{{alertName}}", "alert_instance_id": "{{alertInstanceId}}", "context_message": "{{context.message}}" }
Example of create test index using the API.
PUT test { "settings" : { "number_of_shards" : 1 }, "mappings" : { "properties" : { "alert_id" : { "type" : "text" }, "alert_name" : { "type" : "text" }, "alert_instance_id" : { "type" : "text" }, "context_message": { "type" : "text" } } } }
Was this helpful?
Thank you for your feedback.