Adding metric charts on the dashboard

On the 'Dashboard' page you can set up a visual representation of the metrics that your jobs are gathering. The DataCleaner monitor comes with some example timeline charts that demonstrate how metrics are plotted, that you can click at a point in these timeline charts and see further details about those metrics.

Now let's see how we can define our own timelines. Select the appropriate group on the left-hand side of the page and then click "New timeline chart". You'll have to select the job which to base the metric data upon and then select from the metrics made available by that job:

Note that the contents of the dialog are highly dependent on the selected job, so the screenshot above will not necessarily resemble the options available to you.

There are four different types of metrics in DataCleaner monitor, and they may or may not be exposed through your job:

  1. Non-parameterized metrics. These are the most "plain" metrics, which will be represented only by a checkbox.

  2. String-parameterized metrics. These are metrics that take a string parameter. For instance we see that the "Match count" metric of the "Pattern finder" component takes a string parameter (screenshot above). In this case the parameter represents the pattern to look for when counting matches. Usually suggestions will be shown in the UI to help you figure out what type of parameter is expected.

  3. Column-parameterized metrics. Some metrics are collected per column. Since we know which columns a specific component is working on, a list of columns and corresponding checkboxes are shown to make the parameter selection easier:

  4. Formula metrics. Lastly, you can define your own metrics based on a formula of other metrics. This functionality is similar to building formulas in a spreadsheet - you simply reference other metrics and provide an equation for calculating the metric.

    Adding a formula metric is done by clicking the "Add metric formula" button and filling out the formula details:

    Metric formulas support the basic mathematical operators: plus (+), minus (-), divide (/) and multiply (*).

When the metric selection is done, a new unsaved timeline is shown:

You can go back to selecting the metrics or customizing the chart's look and feel by clicking the 'Wrench' icon, or you can start by saving it using the save icon.

Names and colors of the metrics in the timeline chart can be customized by clicking the legend of the chart.