Setup

The chapter covers the configuration of Insights.

Choose your statistics source

Insights can gather data from multiple sources. Currently you can gather data from both the Onegini Customer Identity Manager and the Token Server.

In order to see any results you must configure at least one source. For each component you need to specify the base url, API username, and API password so that the app can make requests to the source to gather data.

Onegini Customer Identity Manager

  • IDP_API_STATISTICS_SOURCE_BASE_URI
  • IDP_API_STATISTICS_SOURCE_USERNAME
  • IDP_API_STATISTICS_SOURCE_PASSWORD

Token Server

  • TS_API_STATISTICS_SOURCE_BASE_URI
  • TS_API_STATISTICS_SOURCE_USERNAME
  • TS_API_STATISTICS_SOURCE_PASSWORD

Please refer to the sources configuration for more details.

Set up web interface credentials

To be able to view the graphs generated by statistics engine, you first need to log in with credentials set by following environmental variables:

  • SPRING_SECURITY_USER_NAME
  • SPRING_SECURITY_USER_PASSWORD

Set up database connection details

Insights uses a database to store its data. Use following properties for database setup:

  • SPRING_DATASOURCE_USERNAME
  • SPRING_DATASOURCE_PASSWORD
  • SPRING_DATASOURCE_URL
  • SPRING_DATASOURCE_DRIVER_CLASS_NAME - should be determined by SPRING_DATASOURCE_URL in most cases
  • DATABASE_TYPE

Please refer to the database configuration for more details.

Set up Insights port

Insights needs to be set up on a specific port. You can stick with default value or change it by setting following property:

  • SERVER_PORT

Launch Insights

You have now configured Insights. Start Insights and check if application started correctly by executing a http GET on:

http://SERVER_HOST:SERVER_PORT/actuator/health

If the retrieved status is UP, you can now go to web interface by going to http://SERVER_HOST:SERVER_PORT and log in with the web interface credentials defined above.

After the initial launch of the application, there will likely be no data available as it has not yet been generated or fetched. The generation job must run successfully before there will be any data to fetch. Please see the scheduling setup of the cron job in the properties.

Insights in Admin panel

It is possible to view Insights graphs in Admin panel in the sources you have configured. Please refer to source documentation for specific configuration.