Associating Trace and TWAMP sessions
  • 05 Jan 2023
  • 3 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Associating Trace and TWAMP sessions

  • Dark
    Light
  • PDF

Article Summary

We've built a really cool capability into Skylight performance analytics where you can associate different types of sessions and then be able to leverage a combined view. The first combo we worked on for this special view was TWAMP and Traceroute. Currently this association is only provisionable via APIs, but we'll work on building it into the UI soon.

assocated sessions.png

See the Skylight Analytics 22.11 Release Notes for more info on what was added in that release.

See the following for more info on setting up traceroute sessions:


Associating via APIs

NOTE

Both sessions should already exist before proceeding with these instructions.

Skylight performance analytics manages its inventory using an endpoint referred to as stitch-it. Head over to our API page to check out the spec and optionally import the OpenAPI spec into your favorite tool.

https://api.accedian.io/session-stitchit.html

We're going to need to follow the below steps to link the TWAMP and traceroute sessions.

  1. Obtain the asset ID of the sessions
  2. Add the traceroute session/object association to the TWAMP object
  3. Verify the association

Step 1 - Obtain asset IDs for sessions to be associated

The asset ID used for the inventory is different from the Object ID that you may be familiar with, but the API supports filtering with object name and object id parameters so that's the easiest way we've found to navigate around here.

NOTE

If you're doing this by hand, a good short cut is to navigate to the session detail view of each of them via the UI to grab the object ID out of the URL. Then use that as the query param.
image.png

Example of TWAMP session
In this example the asset ID is 0x637.

{
    "data": [
        {
            "id": "0x637",
            "type": "monitoredObject",
            "attributes": {
                "actuatorName": "",
                "actuatorType": "accedian-vnid",
                "createdTimestamp": "2022-08-23T18:32:34Z",
                "destinationLocation": {
                    "latitude": 52.13267,
                    "longitude": -106.66871
                },
                "lastModifiedTimestamp": "2022-11-08T18:39:41Z",
                "meta": {
                    "region": "central",
                    "source_city": "calgary"
                },
                "objectId": "32558-F648E24B-AB01-4B95-8CC6-1AB6611FCCC0",
                "objectName": "E20767_JKL_2_ENB_CS6",
                "objectType": "twamp-sf",
                "reflectorName": "",
                "reflectorType": "unknown",
                "reportingMonitoredObjectId": "32558-F648E24B-AB01-4B95-8CC6-1AB6611FCCC0",
                "sourceLocation": {
                    "latitude": 51.048363,
                    "longitude": -114.06374
                },
                "tenantId": "<tenant uuid>",
                "topology": [
                    "calgary",
                    "rtr0110",
                    "rtr0110",
                    "Saskatoon"
                ]
            }
        }
    ]
}

Example of Traceroute session
In this example the asset ID is 0x71d0.

{
    "data": [
        {
            "id": "0x71d0",
            "type": "monitoredObject",
            "attributes": {
                "actuatorName": "",
                "actuatorType": "accedian-vnid",
                "createdTimestamp": "2022-10-12T21:21:45Z",
                "lastModifiedTimestamp": "2022-10-12T21:21:45Z",
                "objectId": "4af15733-0018-4754-8f67-eb577e38c458",
                "objectName": "driver4-trace-accedian.com",
                "objectType": "trace",
                "reflectorName": "",
                "reflectorType": "",
                "reportingMonitoredObjectId": "4af15733-0018-4754-8f67-eb577e38c458",
                "tenantId": "<tenant uuid>",
                "topology": []
            }
        }
    ]
}

Step 2 - Associate path-trace session to TWAMP session

Now that you have both IDs, you need to add association to the TWAMP session via a patch call like the following

{
    "data": {
        "associatedObjects": {
            "data": [
                {
                    "id": "{{insert traceroute Asset Id here}}",
                    "type": "addMonitoredObject"
                }
            ]
        }
    }
}

Step 3 - Verify the association

Re-query the TWAMP session afterwards using the same call as in Step 1 to check that there is now an association!

{
    "data": [
        {
            "id": "0x637",
            "type": "monitoredObject",
            "attributes": {
                "actuatorName": "",
                "actuatorType": "accedian-vnid",
                "associatedObjects": [
                    {
                        "id": "0x71d0",
                        "type": "monitoredObject",
                        "attributes": {
                            "actuatorName": "",
                            "actuatorType": "accedian-vnid",
                            "createdTimestamp": "2022-10-12T21:21:45Z",
                            "lastModifiedTimestamp": "2022-10-12T21:21:45Z",
                            "objectId": "4af15733-0018-4754-8f67-eb577e38c458",
                            "objectName": "driver4-trace-accedian.com",
                            "objectType": "trace",
                            "reflectorName": "",
                            "reflectorType": "",
                            "reportingMonitoredObjectId": "4af15733-0018-4754-8f67-eb577e38c458",
                            "tenantId": "tenant uuid",
                            "topology": null
                        }
                    }
                ],
                "createdTimestamp": "2022-08-23T18:32:34Z",
                "destinationLocation": {
                    "latitude": 52.13267,
                    "longitude": -106.66871
                },
                "lastModifiedTimestamp": "2022-11-08T18:39:41Z",
                "meta": {
                    "region": "central",
                    "source_city": "calgary"
                },
                "objectId": "32558-F648E24B-AB01-4B95-8CC6-1AB6611FCCC0",
                "objectName": "E20767_JKL_2_ENB_CS6",
                "objectType": "twamp-sf",
                "reflectorName": "",
                "reflectorType": "unknown",
                "reportingMonitoredObjectId": "32558-F648E24B-AB01-4B95-8CC6-1AB6611FCCC0",
                "sourceLocation": {
                    "latitude": 51.048363,
                    "longitude": -114.06374
                },
                "tenantId": "tenant uuid",
                "topology": [
                    "calgary",
                    "rtr0110",
                    "rtr0110",
                    "Saskatoon"
                ]
            }
        }
    ]
}

Representation in Analytics UI

Once a path-trace session has been associated with a TWAMP session an extra tab will be available on the session details page.

Untitled.png

Data (specifically path changes) from the path-trace session results is integrated into the TWAMP session charts.

Untitled 1.png


© 2024 Accedian Networks Inc. All rights reserved. Accedian®, Accedian Networks®,  the Accedian logo™, Skylight™, Skylight Interceptor™ and per-packet intel™, are trademarks or registered trademarks of Accedian Networks Inc. To view a list of Accedian trademarks visit: http://accedian.com/legal/trademarks/. 


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.