...
| Tip |
|---|
This is the most important configuration file in Insights product. It is required to run WAR file, Platform engine jar as well as Report jar. It is important to keep the server-config.json updated with the latest changes. Find the various components of server-config.json on this page. |
...
| title | Sample Server Config Json file |
|---|
| Info |
|---|
server-config.json file is present at "%INSIGHTS_HOME%"\.InSights environment variable path location. |
Sample Server Config Json file
...
| language | json |
|---|
...
| Anchor | ||||
|---|---|---|---|---|
|
| Tip |
|---|
This is the most important configuration file in Insights product. It is required to run WAR file, Platform engine jar as well as Report jar. It is important to keep the server-config.json updated with the latest changes. Find the various components of server-config.json on this page. |
Introduction :
This is most important file in Insights Application which contain all necessary configuration to run product
Configuration from UI :
Go to section Configuration –> server configuration
Update all value and save the record
check mandatory field in Mandatory Fields/Sections mentioned below
...
| Expand | |||||||
|---|---|---|---|---|---|---|---|
| |||||||
Sample Server Config Json file
|
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
| title | Components of server-config.json |
|---|
...
Component
...
Significance
...
"endpointData": {
"elasticSearchEndpoint": "http://localhost:9200"
}
...
endpointData - It has the configuration for Elaticsearch database.
elasticSearchEndpoint - It is the server path, where Elasticsearch database is hosted.
...
"graph":{
"endpoint":"http://localhost:7474",
"authToken":"",
"boltEndPoint":"bolt://localhost:7687",
"maxIdleConnections":25
}
...
graph - This section refers to Neo4j database configurations.
endpoint - It is the server/hostname where Neo4j is hosted.
authToken - It is token for Neo4j authentication.
boltEndPoint - Its Neo4j boltEndPoint
maxIdleConnections - Maximum connection use for Neo4j (use only with java Neo4j driver)
...
"grafana": {
"grafanaEndpoint": "http://localhost:3000",
"grafanaDBEndpoint": "jdbc:postgresql://localhost:5432/grafana",
"adminUserName": "admin",
"adminUserPassword": "admin",
"dbUserName": "user",
"dbPassword": "password"
}
...
grafana - It contains the details of Grafana.
grafanaEndpoint - It is the web server location where Grafana is hosted.
grafanaDBEndpoint - It's the configuration to connect PostgreSQL database.
adminUserName - It is the username of admin for Grafana.
adminUserPassword - It is the corresponding password for the username of admin for Grafana.
dbUserName - It is the username to log intoPostgreSQL.
dbUserName - It is the corresponding password for the username to log into PostgreSQL.
...
"postgre": {
"userName" : "user",
"password" : "password",
"insightsDBUrl": "jdbc:postgresql://127.0.0.1:5432/insight",
"grafanaDBUrl": "jdbc:postgresql://127.0.0.1:5432/grafana"
}
...
postgre - This module has the configurations for PostgreSQL
userName - It is the username to log into PostgreSQL
password - It is the corresponding password for the username to log into PostgreSQL.
insightsDBUrl - It is the JDBC connectivity URL of Insights data storage index, which stores information related to Insights Application.
grafanaDBUrl - It is the JDBC connectivity URL of Grafana data storage index, which stores information related to Grafana.
...
"messageQueue": {
"host": "localhost",
"user": "iSight",
"password": "iSight",
"prefetchCount" : 10
}
messageQueue - These are the configurations related to RabbitMQ server.
host - It is the host location at which RabbitMQ is running.
user - It is username to log into RabbitMQ application.
password - It is the corresponding password for the username to log into RabbitMQ application.
prefetchCount - It is to control the number of files consumed by the Insights Engine.The value should be calculated based on number of messages and system configuration.
...
"agentDetails": {
"docrootUrl": "https://infra.cogdevops.com:8443/repository/docroot/insights_install/release",
"unzipPath": "[drive_name]://[folder_path]",
"agentExchange": "iAgent",
"agentPkgQueue": "INSIGHTS.AGENTS.PACKAGE"
}
...
agentDetails - These are the configurations needed to setup agents in Insights Application.
docrootUrl - It is the location from which agent would be downloaded in a zip file.
unzipPath - It is the local system path where the downloaded zip file would be extracted.
agentExchange - It is the channel where agent related data exchanges will take place.
agentPkgQueue - It is the queue name where all the various agents will be queued.
...
"queryCache":
{
"esCacheIndex": "neo4j-cached-results-custom"
}
...
queryCache - This configuration helps us to set custom Neo4j data source's query caching index in Elasticsearch.
esCacheIndex - It is the custom index of Elaticsearch where cache results will be stored.
...
"insightsServiceURL": "https://localhost:8080"
...
insightsServiceURL - It is the web server host and port where "PlatformService.war" file is deployed and run.
...
"disableAuth": false
...
disableAuth - This option is used to turn ON/OFF authentication service.
...
"enableNativeUsers": true
...
enableNativeUsers - This option is used to enable native users from Grafana to log into Insights application.
...
"insightsTimeZone": "US/Central"
...
insightsTimeZone - It is the local timezone of the country/place.
...
"enableOnlineDatatagging": true
...
enableOnlineDatatagging - This property is required to enable/disable Business Mapping on data.
...
"enableOnlineBackup": true
...
enableOnlineBackup - This property is required to enable the backup when the Engine is running.
...
"autheticationProtocol":"NativeGrafana"
...
|
| Expand | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
If existing application have agent configured with vault then it is mandatory to upgrade it using following steps
|
| Expand | ||||
|---|---|---|---|---|
| ||||
Another way is to configure server config directly on file system INSIGHTS_HOME\.InSights\server-config.json and restart tomcat and other services |
| Expand | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
|
...