Kibana is an open source workbench that allows for the visualization of data that has been previously indexed in our analytics warehouse. Kibana is currently available for the Ultimate and Enterprise editions of Memsource.
Note: In order to process data from Memsource, Kibana version 4.1.6 is required. It can be downloaded from the official Elastic website directly.
Downloading, Installation, and Start-Up
- In your Memsource account, go to Setup and scroll down to Analytics & Reporting. Select Kibana and click on Setup Kibana Access. This will generate a unique URL that you will need in order to visualize data with Kibana.
- Download the correct installer for your operating system.
- Extract the downloaded ZIP file.
- Inside the 'config' subfolder, you will find the 'kibana.yml' configuration file. Open it using a text editor or a source code editor, such as Notepad++ or jEdit (for a clearer display of the code).
- Replace the value of the elasticsearch_url (usually "http://localhost:9200") with the URL you have generated in your Memsource account and make sure the kibana_index is set to .kibana like this:
- Save the file.
- To start Kibana, go to the 'bin' subdirectory in the extracted folder and double-click kibana.bat (Windows users), or kibana (other users).
- If you have setup everything correctly, you will see this:
This means that Kibana is ready for use. This command window has to stay open in order to maintain the connection to Kibana.
- Open your browser and type localhost:5601 into the address bar to access the visualization workbench.
- Start Kibana as described in step 7 of the previous section.
- When you log in for the first time, you will be prompted to configure the index patterns that you want to utilize for your visualization. Do this in Settings under the Indices menu.
The following index patterns are currently available:
- com.memsource.web.analytics.data.job (job.dateCreated)
- com.memsource.web.analytics.data.jobpart (jobPart.dateCreated)
- com.memsource.web.analytics.data.analysis (jobPart.dateCreated)
- com.memsource.web.analytics.data.costs (jobPart.dateCreated)
- com.memsource.web.analytics.data.api (request.date)
- When creating your indexes, the expression in brackets represent the recommended Time-field name for the given index. You can configure any or all the indexes available.
- Once the indexes are registered, you can start visualizing the data through the Visualize tab.
Classification of Indexes
- Job index
- Contains information about job sizes (words, pages etc.), who created the jobs, when they were created, filetypes, projects, and organizations they belong to.
- Job Part index
- Jobs themselves do not have statuses or assigned users. This type of information is stored in terms of job parts (i.e. jobs in different workflow steps constitute different job parts). Otherwise, the same of data as in the Job index are available (filetype, project, organization etc.).
- Analysis index
- Information about Analyzed Job Parts (divided into match categories) with and without Net Rate applied.
- Costs index
- Costs for the Job Part (based on Price Lists).
- API index
- Summary of API usage.
Below you will find a short guide on how to create your visualization. For more information about the possible options and types of visualizations, please consult the Kibana User Guide.
- The Visualize tab allows you to choose the type of visualization you want to use. On the very bottom of the page, you can also see previously saved visualizations.
- Select either the new or saved search option.
- For a new search, you will be given a choice of which of the configured indexes you wish to use.
- You will see an empty graph with various options you can select and feed into it.
- By default, Kibana selects the interval of Last 15 minutes; select a different interval if needed.
- In the left panel, you can select the metrics to use for your visualization.
- The first section determines the type of data used to create the graph and the aggregation method. This graph will determine the overall number of units within the given metrics.
- Section Buckets allows you to divide the graph based on the selected parameters.
- You can also save the given graph if you want to avoid repetitive manual configuration
Sample Charts and Configurations
You can find sample charts with their respective setup on our dedicated page.
- You can visualize the saved graphs on the Kibana Dashboard.
- Each of the graphs set up in the Dashboard will then reflect the Time Field selected in the Top panel.
- The graphs can be resized, moved, and ordered to provide an adequate view of the data.
- Dashboards can also be saved and stored for later use.