Establish connectivity to Elasticsearch
An Administrator can use the process described in this article to create a new Plugin Data Source to fetch data using Elasticsearch.
- Java 8 software must be installed and running on the same server as the Metric Insights' Data Collector.
For clustered environments:
- [prior to 5.6.1] Elasticsearch configuration file must be created and added to the /Insightd (Windows) or /datacollector (Linux) directory
- See details below
The config file should contain the following Parameter Values:
- Cluster Name
- Cluster Headers
- Inner API Port
- Enabled SSL
- Transport Sniff
Place the Elasticsearch configuration file at:
C:\Program Files (x86)\Metric Insights\Insightd\plugins(for Windows-based Data Collectors)
opt/mi/datacollector/plugins(for Linux-based Data Collectors)
1. Access Admin > Data Sources
At the bottom of the screen click [+ New Data Source].
The Select the Type of New Data Source pop-up opens.
2. Select "Other" Data Source Type and choose "Elasticserach" from the drop-down list
Proceed with creating a Data Source by moving to the Next step.
3. Required Elasticsearch Parameters
- Data Source Name is defaulted but you may modify it
- Server: specify the endpoint server (can be local or remote)
- Username: Note that your Username must be in the same format that your Elasticsearch server uses for authentication
- Plugin Password: enter your password credential
4. Optional Elasticsearch Parameters (for clustered servers)
As of Release 5.6.1, additional Parameters for clustered servers can be configured in the Data Source connection profile (UI) instead of the Elasticsearch configuration file.
- Name of ElasticSearch cluster: provide the name of your Elasticsearch cluster
- Cluster Headers: specify the name(s) of the required Cluster Header(s)
- Trasport API port: input the API communication port
- Enable SSL (Cluster): set to 'yes'
- Transport Sniff (Cluster): set to 'yes'
5. Advanced Configuration
- Use Remote Data Collector: switch to "yes" and add a Remote Data Collector by clicking [+New Remote Collector] under Remote Collectors settings
Generate Object List
- automatically: all Reports are going to be fetched by the system
- manually: Reports may be added one-by-one or via CSV file
- Object List Refresh Trigger: from the dropdown, select the Trigger that will be used to fetch data via the Elasticsearch plugin
- Object Selection Method: specify how Elasticsearch Reports will be fetched
- Optionally, state the maximum number of concurrent Threads to utilize during data and/or image fetch to be used in background processing when the system updates Reports for this Data Source
- If you do not specify any value for this setting, batch data collection processing will be single-threaded
- Test Connection: this will also Save your entries
6. Other Settings
- You can create Datasets directly from the respective tab
- Click Permissions to assign permissions to the Data Source to Groups or Power Users