- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.17
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- AI Assistant settings
- Alerting and action settings
- APM settings
- Banners settings
- Cases settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboards
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- Search
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- Cases
- Connectors
- Amazon Bedrock
- Cases
- CrowdStrike
- D3 Security
- Google Gemini
- IBM Resilient
- Index
- Jira
- Microsoft Teams
- Observability AI Assistant
- OpenAI
- Opsgenie
- PagerDuty
- SentinelOne
- Server log
- ServiceNow ITSM
- ServiceNow SecOps
- ServiceNow ITOM
- Swimlane
- Slack
- TheHive
- Tines
- Torq
- Webhook
- Webhook - Case Management
- xMatters
- Preconfigured connectors
- License Management
- Maintenance windows
- Manage data views
- Numeral Formatting
- Rollup Jobs
- Manage saved objects
- Security
- Spaces
- Advanced Settings
- Tags
- Upgrade Assistant
- Watcher
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Osquery manager API
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Synthetics APIs
- Uptime APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Upgrade notes
- Kibana 8.17.0
- Kibana 8.16.2
- Kibana 8.16.1
- Kibana 8.16.0
- Kibana 8.15.5
- Kibana 8.15.4
- Kibana 8.15.3
- Kibana 8.15.2
- Kibana 8.15.1
- Kibana 8.15.0
- Kibana 8.14.3
- Kibana 8.14.2
- Kibana 8.14.1
- Kibana 8.14.0
- Kibana 8.13.4
- Kibana 8.13.3
- Kibana 8.13.2
- Kibana 8.13.1
- Kibana 8.13.0
- Kibana 8.12.2
- Kibana 8.12.1
- Kibana 8.12.0
- Kibana 8.11.4
- Kibana 8.11.3
- Kibana 8.11.2
- Kibana 8.11.1
- Kibana 8.11.0
- Kibana 8.10.4
- Kibana 8.10.3
- Kibana 8.10.2
- Kibana 8.10.1
- Kibana 8.10.0
- Kibana 8.9.2
- Kibana 8.9.1
- Kibana 8.9.0
- Kibana 8.8.2
- Kibana 8.8.1
- Kibana 8.8.0
- Kibana 8.7.1
- Kibana 8.7.0
- Kibana 8.6.1
- Kibana 8.6.0
- Kibana 8.5.2
- Kibana 8.5.1
- Kibana 8.5.0
- Kibana 8.4.3
- Kibana 8.4.2
- Kibana 8.4.1
- Kibana 8.4.0
- Kibana 8.3.3
- Kibana 8.3.2
- Kibana 8.3.1
- Kibana 8.3.0
- Kibana 8.2.3
- Kibana 8.2.2
- Kibana 8.2.1
- Kibana 8.2.0
- Kibana 8.1.3
- Kibana 8.1.2
- Kibana 8.1.1
- Kibana 8.1.0
- Kibana 8.0.0
- Kibana 8.0.0-rc2
- Kibana 8.0.0-rc1
- Kibana 8.0.0-beta1
- Kibana 8.0.0-alpha2
- Kibana 8.0.0-alpha1
- Developer guide
Opsgenie connector and action
editOpsgenie connector and action
editAn Opsgenie connector enables you to create and close alerts in Opsgenie. In particular, it uses the Opsgenie alert API.
To create this connector, you must have a valid Opsgenie URL and API key. For configuration tips, refer to Configure an Opsgenie account.
Create connectors in Kibana
editYou can create connectors in Stack Management > Connectors or as needed when you’re creating a rule. For example:
Connector configuration
editOpsgenie 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.
- URL
-
The Opsgenie URL. For example, https://api.opsgenie.com or https://api.eu.opsgenie.com.
If you are using the
xpack.actions.allowedHosts
setting, make sure the hostname is added to the allowed hosts. - API Key
- The Opsgenie API authentication key for HTTP basic authentication. For more details about generating Opsgenie API keys, refer to Opsgenie documentation.
Test connectors
editAfter you create a connector, use the Test tab to test its actions:
Create alert action
editWhen you create a rule that uses an Opsgenie connector, its actions (with the exception of recovery actions) create Opsgenie alerts. You can test this type of action when you create or edit your connector:
You can configure the create alert action through the form view or using a JSON editor.
Form view
editThe create alert action form has the following configuration properties.
- Message
- The message for the alert (required).
- Opsgenie tags
- The tags for the alert (optional).
- Priority
- The priority level for the alert.
- Description
- A description that provides detailed information about the alert (optional).
- Alias
- The alert identifier, which is used for alert deduplication in Opsgenie. For more information, refer to the Opsgenie documentation (optional).
- Entity
- The domain of the alert (optional).
- Source
- The source of the alert (optional).
- User
- The display name of the owner (optional).
- Note
- Additional information for the alert (optional).
JSON editor
editA JSON editor is provided as an alternative to the form view and supports additional fields not shown in the form view. The JSON editor supports all of the forms configuration properties but as lowercase keys as described in the Opsgenie API documentation. The JSON editor supports the following additional properties:
- responders
- The entities to receive notifications about the alert (optional).
- visibleTo
- The teams and users that the alert will be visible to without sending a notification to them (optional).
- actions
- The custom actions available to the alert (optional).
- details
- The custom properties of the alert (optional).
{ "message": "An example alert message", "alias": "Life is too short for no alias", "description":"Every alert needs a description", "responders":[ {"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c", "type":"team"}, {"name":"NOC", "type":"team"}, {"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8", "type":"user"}, {"username":"trinity@opsgenie.com", "type":"user"}, {"id":"aee8a0de-c80f-4515-a232-501c0bc9d715", "type":"escalation"}, {"name":"Nightwatch Escalation", "type":"escalation"}, {"id":"80564037-1984-4f38-b98e-8a1f662df552", "type":"schedule"}, {"name":"First Responders Schedule", "type":"schedule"} ], "visibleTo":[ {"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c","type":"team"}, {"name":"rocket_team","type":"team"}, {"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8","type":"user"}, {"username":"trinity@opsgenie.com","type":"user"} ], "actions": ["Restart", "AnExampleAction"], "tags": ["OverwriteQuietHours","Critical"], "details":{"key1":"value1","key2":"value2"}, "entity":"An example entity", "priority":"P1" }
Close alert action
editWhen you create a rule that uses an Opsgenie connector, its recovery actions close Opsgenie alerts. You can test this type of action when you create or edit your connector:
The close alert action has the following configuration properties.
- Alias
- The alert identifier, which is used for alert deduplication in Opsgenie (required). The alias must match the value used when creating the alert. For more information, refer to the Opsgenie documentation.
- Note
- Additional information for the alert (optional).
- Source
- The display name of the source (optional).
- User
- The display name of the owner (optional).
Connector networking configuration
editUse the Action configuration settings to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings
to set per-host configurations.
Configure an Opsgenie account
editAfter obtaining an Opsgenie instance, configure the API integration. For details, refer to the Opsgenie documentation.
If you’re using a free trial, go to the Teams
dashboard and select the appropriate team.
Select the Integrations
menu item, then select Add integration
.
Search for API
and select the API
integration.
Configure the integration and ensure you record the API Key
. This key will be used to populate the API Key
field when creating the Kibana Opsgenie connector. Click Save Integration
after you finish configuring the integration.
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now