Skip to content

Getting Started

Running First Workflow

Create Workspace

Navigate to Workspace in the left navigation bar. To create your first workspace, click the Create New Workspace button, enter a workspace name, and click Ok.

Create Workspace

Create Workflow

Navigate to Workflow in the left navigation bar. To create your first workflow, click the Create New Workflow button, enter a workflow name, and click Ok.

Create Workflow

Click and drag New Task in between the two circles.

New Task

Double click on the new task to open the task settings.

  • Enter ping in Task name field
  • Enter ping -c 10 localhost in Command field

Ping Task Settings

Click Save, check the “Check here to run this workflow upon saving”, click the Select workspace dropdown and select the created workspace, then click Save.

Run Workflow

Click on the Insights Dashboard on the left navigation submenu to see workflow status.

Insights Dashboard

Creating First Parser

Navigate to Parser Library on the left navigation submenu, click Create New Parse Rule. Click ping task to expand tree, select the latest run timestamp, and click output.log. Enter ping latency in Parser Name field. Click Add Stage and select $readlines parser operation in the dropdown.

Create Parser Ping Latency

Add the following additional stages with arguments.

1
{}
1
2
3
{
  "pattern": ".*\\d+ bytes from.*"
}
1
2
3
4
5
6
7
{
  "pattern": "([0-9:\\-T\\.Z]+).*time=([0-9\\.]+)",
  "keys": [
    "timestamp",
    "latency"
  ]
}
1
2
3
4
5
6
{
  "types": {
    "timestamp": "datetime",
    "latency": "float"
  }
}

Note

See Parser Operator Reference for more details on operators and arguments.

Edit Parser Ping Latency

Finally click Save. When prompted to “Enable task error counter?”, select No. The next time you run the ping workflow, the parser will automatically run. Since we just created the parser, the existing output.log has not been parsed. We can trigger it manually.

Navigate to Artifact Viewer on the left navigation submenu. You will see the output.log listed from the first workflow run. The Parsers column will show a count of 1 that represents the ping latency parser we just created. The Parsed column will show a count of 0 with a warning icon to indicate a parser has not been run on the artifact.

Double click on the output.log artifact and select the ping latency tab which corresponds to the created parser. Click the Run Parser button to parse output.log and a preview of the parsed data will appear.

Artifact Viewer Ping Latency

Creating First Dashboard Chart

Navigate to Metrics on the left navigation menu, click Create New Chart. Enter ping latency in Chart Name field and add the following stages.

1
2
3
{
  "parser.name": "ping latency"
}
1
2
3
{
  "path": "$data"
}
1
2
3
{
  "data.timestamp": -1
}
1
10
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "_id": 0,
  "data": {
    "$push": {
      "x": {
        "$toLong": "$data.timestamp"
      },
      "y": "$data.latency"
    }
  }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "_id": 0,
  "labels": [
    "latency (ms)"
  ],
  "datasets": [
    {
      "data": "$data"
    }
  ]
}

Note

See MongoDB Aggregation for more details on operators and arguments.

You should see a preview of the chart as follows. Then click Save.

Create Chart

Finally, navigate back to Dashboard on the left navigation menu. Under the Design Status section, click Add Chart, select ping latency chart, and click Ok. Now you will be able to see a real-time chart for ping latency. The next time the ping task is run, the output will get parsed and the chart will update automatically.

Configure Dashboard

Next Steps

Now you can create your own workflows and leverage the capabilities of TymeDeck to automate your processes.

You can also continue to read this documentation learn more details on all the features TymeDeck has to offer.