Example: Categories

Example: Categories

Watchr plots can belong to categories, which is a way of grouping related data together. Note the data file performance_day_1.xml below has three number values on the inner "timing" element - "max", "min", and "mean."

For this example, we will construct a config file that plots each of these three values separately. Each plot will belong to separate categories.

Data File: performance_day_1.xml

<?xml version="1.0"?>
<performance-report date="2021-04-05T22:21:21" name="nightly_run_2021-04-05">
    <timing name="measurement" max="5.0" min="0.0" mean="2.5"/>
</performance-report>

Watchr Config: config.json

{
    "plots" : {
        "files" : {
            "fileName": "performance_*",
            "type" : "xml"
        },
        "categories" : [
            "max",
            "min",
            "mean"
        ],
        "plot" : [
            {
                "name" : "Max Plot",
                "category" : "max",
                "dataLines" : [
                    {
                        "name" : "Max Data Line",
                        "x" : {
                            "getElement" : "performance-report",
                            "getPath": "*",
                            "getKey" : "date",
                            "unit" : "date"
                        },
                        "y" : {
                            "getElement" : "performance-report|timing",
                            "getPath": "*/measurement",
                            "getPathAttribute": "name",
                            "getKey" : "max",
                            "unit" : "seconds"
                        }
                    }
                ]
            }, {
                "name" : "Min Plot",
                "category" : "min",
                "dataLines" : [
                    {
                        "name" : "Min Data Line",
                        "x" : {
                            "getElement" : "performance-report",
                            "getPath": "*",
                            "getKey" : "date",
                            "unit" : "date"
                        },
                        "y" : {
                            "getElement" : "performance-report|timing",
                            "getPath": "*/measurement",
                            "getPathAttribute": "name",
                            "getKey" : "min",
                            "unit" : "seconds"
                        }
                    }
                ]
            }, {
                "name" : "Mean Plot",
                "category" : "mean",
                "dataLines" : [
                    {
                        "name" : "Mean Data Line",
                        "x" : {
                            "getElement" : "performance-report",
                            "getPath": "*",
                            "getKey" : "date",
                            "unit" : "date"
                        },
                        "y" : {
                            "getElement" : "performance-report|timing",
                            "getPath": "*/measurement",
                            "getPathAttribute": "name",
                            "getKey" : "mean",
                            "unit" : "seconds"
                        }
                    }
                ]
            }
        ]
    }
}

Watchr's Actions:

1. Locate the x data point

• at the first element of the XML ("getPath": "*")
• with the element name performance-report ("getElement" : "performance-report")
• and attribute "date" ("getKey" : "date").
• The X value will be located within the "date" attribute.

2. Locate the y data point

• at the path "nightly_run_2021-04-05 / measurement" ("getPath": "*/measurement")
• with the element name "performance-report" or "timing" ("getElement" : "performance-report|timing")
• and the guiding path attribute "name" ("getPathAttribute": "name").
• The Y value will be located within the "value" attribute. ("getKey" : "value").

3. A single point x="2021-04-05T22:21:21", y="1.0" will be extracted from the XML.
4. Finally, Watchr will plot a single 2D scatter plot graph, with the X axis "date" and the Y axis "seconds" (as dictated by the unit fields). The single point x="2021-04-05T22:21:21", y="1.0" will be plotted.

Command Line:

watchr config.json performance_day_1.xml