Data reference
Elasticsearch indices are named collections of JSON documents that store NetFoundry telemetry data. Both the Reporting API and the Metrics API query these indices to return network metrics and event data. Each index captures a different category of telemetry, from circuit-level latency to service dial events.
Available indices
| Index | Description |
|---|---|
ncctrllatency | Latency and traffic metrics for control traffic between controllers and edge routers. |
ncevents | API session creation records with IP and geolocation data. Also includes router online/offline events. |
ncfabriccircuits | Circuit creation and failure events with full path detail: initiator, ingress router, egress router, and terminator. |
nclinklatency | Latency measurements between edge routers over fabric links, captured by probe. |
ncserviceevents | Individual service dial success and failure events. |
ncservicehealth | Aggregated success rate metrics across all attempted service connections. |
ncutilization | Data volume per circuit, broken down by direction. Correlates to circuit IDs in ncfabriccircuits. |
Sample records
Each section below shows a sample JSON document (or individual record) from that index, including all available fields.
Controller latency (ncctrllatency)
{
"_index": ".ds-ncctrllatency-2024.04.06-000018",
"_type": "_doc",
"_id": "E4aLwo4Br68Q_yTzOnCI",
"_version": 1,
"_score": null,
"fields": {
"target_index": [
"ncctrllatency"
],
"organizationId.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"providerName.keyword": [
"AWS"
],
"target_index.keyword": [
"ncctrllatency"
],
"network_group_id": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"network_group_id.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"p95": [
97592824.0
],
"nf_edge_router_id": [
"5d6322e4-b2d0-48d2-9962-3e0b45ed8d2f"
],
"router_id.keyword": [
"2Ztz3mZ3U"
],
"organizationId": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"p99": [
112534608.0
],
"min": [
93030144
],
"metric.keyword": [
"ctrl.latency"
],
"providerId": [
"i-0a9a425cd738f9ab3"
],
"@version": [
"1"
],
"router_id": [
"2Ztz3mZ3U"
],
"providerName": [
"AWS"
],
"timestamp": [
"2024-04-09T11:07:46.162Z"
],
"nf_edge_router_name": [
"Edge Router 1"
],
"providerId.keyword": [
"i-0a9a425cd738f9ab3"
],
"max": [
117218621
],
"count": [
36813
],
"network_name": [
"NetFoundry Network"
],
"nf_edge_router_name.keyword": [
"nfer-swissport-coresvc-euc1"
],
"@version.keyword": [
"1"
],
"namespace.keyword": [
"metrics"
],
"nf_edge_router_id.keyword": [
"5d6322e4-1111-48d2-9962-3e0b45ed8d2f"
],
"network_name.keyword": [
"NetFoundry Network"
],
"processed": [
1
],
"network_id": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"@timestamp": [
"2024-04-09T11:08:06.635Z"
],
"metric": [
"ctrl.latency"
],
"network_id.keyword": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"mean": [
95487584.0
],
"namespace": [
"metrics"
]
},
"sort": [
1712660886635
]
}
Network events (ncevents)
{
"_index": ".ds-ncevents-2024.04.07-000011",
"_type": "_doc",
"_id": "c1GKwo4BOJ2WR8PPwU10",
"_version": 1,
"_score": null,
"fields": {
"target_index": [
"ncevents"
],
"network_group_id": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"geo.region_code.keyword": [
"08"
],
"network_group_id.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"geo.longitude": [
101.0731
],
"api_session_id": [
"clus85pm07c46fqmyobo4wj6j"
],
"geo.location.lat": [
4.6153
],
"geo.region_code": [
"08"
],
"organizationId": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"event_type": [
"deleted"
],
"nf_endpoint_name": [
"John Q. Public"
],
"geo.country_code2": [
"MY"
],
"geo.region_name.keyword": [
"Perak"
],
"geo.postal_code.keyword": [
"30100"
],
"geo.country_code3": [
"MY"
],
"network_name": [
"NetFoundry Network"
],
"@version.keyword": [
"1"
],
"geo.country_code2.keyword": [
"MY"
],
"network_name.keyword": [
"NetFoundry Network"
],
"network_id": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"api_session_id.keyword": [
"clus85pm07c46fqmyobo4wj6j"
],
"geo.country_name.keyword": [
"Malaysia"
],
"geo.city_name": [
"Ipoh"
],
"token.keyword": [
"1d79a279-fa31-44ab-b98c-a936fcb79e3b"
],
"geo.continent_code": [
"AS"
],
"organizationId.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"target_index.keyword": [
"ncevents"
],
"nf_endpoint_id": [
"17bb2aa8-7d17-1234-90ef-9a50c6963ec8"
],
"nf_endpoint_name.keyword": [
"NetFoundry User"
],
"event_type.keyword": [
"deleted"
],
"geo.continent_code.keyword": [
"AS"
],
"geo.timezone.keyword": [
"Asia/Kuala_Lumpur"
],
"geo.country_name": [
"Malaysia"
],
"@version": [
"1"
],
"geo.ip.keyword": [
"10.22.246.44"
],
"identity_id.keyword": [
"GKP3wyPz1B"
],
"timestamp": [
"2024-04-09T11:07:11.735Z"
],
"geo.ip": [
"10.75.246.44"
],
"geo.timezone": [
"Asia/Kuala_Lumpur"
],
"geo.location.lon": [
101.0731
],
"geo.postal_code": [
"30100"
],
"identity_id": [
"GKP3wfedrB"
],
"geo.region_name": [
"Perak"
],
"namespace.keyword": [
"edge.apiSessions"
],
"geo.latitude": [
4.6153
],
"ip_address": [
"180.75.246.44"
],
"nf_endpoint_id.keyword": [
"17bb2aa8-7d17-6754-90ef-9a50c6963ec8"
],
"ip_address.keyword": [
"10.75.246.44"
],
"geo.country_code3.keyword": [
"MY"
],
"token": [
"1d79a279-fa31-44ab-b98c-a936fcb79e3b"
],
"geo.city_name.keyword": [
"Ipoh"
],
"processed": [
1
],
"@timestamp": [
"2024-04-09T11:07:35.720Z"
],
"network_id.keyword": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"namespace": [
"edge.apiSessions"
]
},
"sort": [
1712660855720
]
}
Fabric circuits (ncfabriccircuits)
{
"_index": ".ds-ncfabriccircuits-2024.04.09-000096",
"_type": "_doc",
"_id": "9YeLwo4Br68Q_yTzeFOl",
"_version": 1,
"_score": null,
"fields": {
"target_index": [
"ncfabriccircuits"
],
"path.terminator_local_addr.keyword": [
"10.184.35.176:52352"
],
"network_group_id": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"key.keyword": [
"fabric.circuits.kIPdnwJ9nP.3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"network_group_id.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"client_id": [
"clsgbyvyh007r76myk4u4xai5"
],
"circuit_id.keyword": [
"kIPdnwJ9nP"
],
"organizationId": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"event_type": [
"created"
],
"nf_endpoint_name": [
"nfer-saputo-coresvc-azure-eastus-v1"
],
"tags.hostId": [
"cuswP5k-E"
],
"terminator_id": [
"03e3da7d-f0ad-405f-8eac-c693a2a006b4"
],
"tags.clientId.keyword": [
"QvxbR6xOq"
],
"failure_cause": [
""
],
"path.terminator_remote_addr.keyword": [
"10.184.35.132:9050"
],
"path.initiator_remote_addr.keyword": [
"10.186.8.12:38302"
],
"creation_timespan": [
3000799
],
"path.links.keyword": [
"2PNduaAVAvj4HVDjotCn2N",
"6j0h9kFPhvt4QDwKQRpcDp"
],
"client_id.keyword": [
"clsgbyvyh007r76myk4u4xai5"
],
"network_name": [
"NetFoundry Network"
],
"@version.keyword": [
"1"
],
"path.initiator_local_addr": [
"10.184.35.132:9050"
],
"network_name.keyword": [
"NetFoundry Network"
],
"network_id": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"path.nodes.keyword": [
"QvxbR6xOq",
"PzIqPIdoH",
"cuswP5k-E"
],
"instance_id": [
""
],
"nf_service_id.keyword": [
"0dea4be7-5ff2-4df8-9bfb-09abf1645809"
],
"path.terminator_remote_addr": [
"10.184.35.132:9050"
],
"organizationId.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"target_index.keyword": [
"ncfabriccircuits"
],
"nf_endpoint_id": [
"b464add4-5ccb-42cc-8ea5-cef764053948"
],
"nf_service_name": [
"service1"
],
"link_count": [
2
],
"path.nodes": [
"QvxbR6xOq",
"PzIqPIdoH",
"cuswP5k-E"
],
"nf_endpoint_name.keyword": [
"endpoint1"
],
"event_type.keyword": [
"created"
],
"instance_id.keyword": [
""
],
"path.initiator_remote_addr": [
"10.186.8.12:38302"
],
"path.terminator_local_addr": [
"10.184.35.176:52352"
],
"path_cost": [
262178
],
"path.egress_id": [
"8yqOdo3"
],
"service_id": [
"fc8bAt1-E"
],
"@version": [
"1"
],
"path.ingress_id.keyword": [
"mLolaEB"
],
"identity_id.keyword": [
"QvxbR6xOq"
],
"tags.clientId": [
"QvxbR6xOq"
],
"circuit_id": [
"kIPdnwJ9nP"
],
"key": [
"fabric.circuits.kIPdnwJ9nP.3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"terminator_id.keyword": [
"03e3da7d-f0ad-405f-8eac-c693a2a006b4"
],
"timestamp": [
"2024-04-09T11:08:19.144Z"
],
"tags.serviceId": [
"fc8bAt1-E"
],
"service_id.keyword": [
"fc8bAt1-E"
],
"tags.hostId.keyword": [
"cuswP5k-E"
],
"path.egress_id.keyword": [
"8yqOdo3"
],
"identity_id": [
"QvxbR6xOq"
],
"nf_service_id": [
"0dea4be7-5ff2-4df8-9bfb-09abf1645809"
],
"namespace.keyword": [
"fabric.circuits"
],
"nf_endpoint_id.keyword": [
"b464add4-5ccb-42cc-8ea5-cef764053948"
],
"tags.serviceId.keyword": [
"fc8bAt1-E"
],
"processed": [
1
],
"path.links": [
"2PNduaAVAvj4HVDjotCn2N",
"6j0h9kFPhvt4QDwKQRpcDp"
],
"nf_service_name.keyword": [
"service"
],
"@timestamp": [
"2024-04-09T11:08:23.848Z"
],
"providerid.keyword": [
""
],
"network_id.keyword": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"path.initiator_local_addr.keyword": [
"10.184.35.132:9050"
],
"providerid": [
""
],
"namespace": [
"fabric.circuits"
],
"path.ingress_id": [
"mLolaEB"
],
"failure_cause.keyword": [
""
]
},
"sort": [
1712660903848
]
}
Link latency (nclinklatency)
{
"_index": ".ds-nclinklatency-2024.04.08-000104",
"_type": "_doc",
"_id": "_1WLwo4BOJ2WR8PPeHJW",
"_version": 1,
"_score": null,
"fields": {
"target_index": [
"nclinklatency"
],
"organizationId.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"link_id.keyword": [
"2gPXKONwDQ73FAnIot2J0q"
],
"target_index.keyword": [
"nclinklatency"
],
"network_group_id": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"nf_source_edge_router_name": [
"Edge Router 1"
],
"source_edge_router_id.keyword": [
""
],
"network_group_id.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"p95": [
160118972
],
"link_id": [
"2gPXKONwDQ73FAnIot2J0q"
],
"organizationId": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"p99": [
160233685
],
"min": [
155245742
],
"metric.keyword": [
"link.latency"
],
"nf_source_edge_router_id.keyword": [
"007afdb0-7c86-4d52-b8c3-0e184066ff2f"
],
"@version": [
"1"
],
"destination_edge_router_id.keyword": [
""
],
"nf_destination_edge_router_name": [
"Edge Router 1"
],
"nf_destination_edge_router_name.keyword": [
"Edge Router 1"
],
"destination_edge_router_id": [
""
],
"timestamp": [
"2024-04-09T11:08:16.417Z"
],
"source_edge_router_id": [
""
],
"max": [
160269421
],
"count": [
151942
],
"network_name": [
"NetFoundry Network"
],
"nf_source_edge_router_name.keyword": [
"Edge Router 1"
],
"@version.keyword": [
"1"
],
"namespace.keyword": [
"metrics"
],
"network_name.keyword": [
"NetFoundry Network"
],
"processed": [
1
],
"network_id": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"nf_source_edge_router_id": [
"007afdb0-7c86-4d52-b8c3-0e184066ff2f"
],
"@timestamp": [
"2024-04-09T11:08:23.492Z"
],
"metric": [
"link.latency"
],
"network_id.keyword": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"nf_destination_edge_router_id": [
"007afdb0-7c86-4d52-b8c3-0e184066ff2f"
],
"mean": [
157131312
],
"namespace": [
"metrics"
],
"nf_destination_edge_router_id.keyword": [
"007afdb0-7c86-4d52-b8c3-0e184066ff2f"
]
},
"sort": [
1712660903492
]
}
Service events (ncserviceevents)
{
"_index": "ncserviceevents-2024.04.09",
"_type": "_doc",
"_id": "oIaLwo4Br68Q_yTzOnSQ",
"_version": 1,
"_score": null,
"fields": {
"target_index": [
"ncserviceevents-2024.04.09"
],
"organizationId.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"target_index.keyword": [
"ncserviceevents-2024.04.09"
],
"nf_service_name": [
"Service 1"
],
"network_group_id": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"network_group_id.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"event_type.keyword": [
"service.dial.success"
],
"organizationId": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"event_type": [
"service.dial.success"
],
"terminator_id": [
"df54f79a-4766-4f18-bc97-c3a4d81fffad"
],
"service_id": [
"ukNOFS5O7E"
],
"@version": [
"1"
],
"terminator_id.keyword": [
"df54f79a-4766-4f18-bc97-c3a4d81fffad"
],
"timestamp": [
"2024-04-09T11:08:05.000Z"
],
"service_id.keyword": [
"ukNOFS5O7E"
],
"count": [
1
],
"network_name": [
"NetFoundry Network"
],
"nf_service_id": [
"6b5e08e6-f3dc-44cb-a9db-d554d4efe5e4"
],
"@version.keyword": [
"1"
],
"namespace.keyword": [
"service.events"
],
"network_name.keyword": [
"NetFoundry Network"
],
"processed": [
1
],
"network_id": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"nf_service_name.keyword": [
"Service 1"
],
"@timestamp": [
"2024-04-09T11:08:07.817Z"
],
"network_id.keyword": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"nf_service_id.keyword": [
"6b5e08e6-f3dc-44cb-a9db-d554d4efe5e4"
],
"namespace": [
"service.events"
]
},
"sort": [
1712660887817
]
}
Service health (ncservicehealth)
{
"_index": ".ds-ncservicehealth-2024.04.08-000013",
"_type": "_doc",
"_id": "44WLwo4Br68Q_yTzIuMy",
"_version": 1,
"_score": null,
"fields": {
"doc_count": [
142
],
"network_id": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"@timestamp": [
"2024-04-09T11:08:01.951Z"
],
"network_id.keyword": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"failure_events": [
0.0
],
"success_events": [
9728.0
],
"success_rate": [
1.0
],
"timestamp": [
"2024-04-09T11:08:01.951Z"
]
},
"sort": [
1712660881951
]
}
Network utilization (ncutilization)
{
"_index": ".ds-ncutilization-2024-2024.04.08-000047",
"_type": "_doc",
"_id": "74eLwo4Br68Q_yTzkKKQ",
"_version": 1,
"_score": null,
"fields": {
"target_index": [
"ncutilization-2024"
],
"network_group_id": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"usage": [
6992
],
"fabric_circuit_id.keyword": [
"grIhnaJsc"
],
"nf_host_name": [
"Host 1"
],
"network_group_id.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"nf_edge_router_id": [
"6b1f9fba-7323-44ab-a0fa-32518d4ba62f"
],
"organizationId": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"nf_endpoint_name": [
"nfer-covestro-coresvc-euc1-v2"
],
"tags.hostId": [
"B0vzNN8XEc"
],
"usage_type": [
"usage.egress.rx"
],
"tags.clientId.keyword": [
"8S6HjSzZ7s"
],
"nf_edge_router_name": [
"nfer-lemongrass-avantra-emea-euw1"
],
"network_name": [
"NetFoundry Network"
],
"@version.keyword": [
"1"
],
"fabric_session_id": [
""
],
"version": [
3
],
"network_name.keyword": [
"NetFoundry Network"
],
"network_id": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"nf_service_id.keyword": [
"ef5dca43-2df5-4174-9f36-ca707a53f6c0"
],
"host_id.keyword": [
"B0vzNN8XEc"
],
"organizationId.keyword": [
"3ab63e5f-c455-4965-b093-3512a20a69e67"
],
"target_index.keyword": [
"ncutilization-2024"
],
"nf_service_name": [
"Service 1"
],
"nf_endpoint_id": [
"494558d3-efdc-47b9-b551-99ac0d901ecc"
],
"source_id.keyword": [
"B0vzNN8XEc"
],
"nf_endpoint_name.keyword": [
"Endpoint 1"
],
"edge_session_id": [
""
],
"nf_host_id.keyword": [
"88f31618-9804-4fb2-b8bd-4ae1fc3df4a5"
],
"nf_host_id": [
"88f31618-9804-4fb2-b8bd-4ae1fc3df4a5"
],
"service_id": [
"3x-odLZ-W"
],
"@version": [
"1"
],
"usage_type.keyword": [
"usage.egress.rx"
],
"identity_id.keyword": [
"8S6HjSzZ7s"
],
"tags.clientId": [
"8S6HjSzZ7s"
],
"nf_host_name.keyword": [
"Host 1"
],
"timestamp": [
"2024-04-09T11:07:00.000Z"
],
"tags.serviceId": [
"3x-odLZ-W"
],
"service_id.keyword": [
"3x-odLZ-W"
],
"tags.hostId.keyword": [
"B0vzNN8XEc"
],
"identity_id": [
"8S6HjSzZ7s"
],
"fabric_session_id.keyword": [
""
],
"nf_service_id": [
"ef5dca43-2df5-4174-9f36-ca707a53f6c0"
],
"nf_edge_router_name.keyword": [
"Edge Router 1"
],
"namespace.keyword": [
"fabric.usage"
],
"nf_endpoint_id.keyword": [
"494558d3-efdc-47b9-b551-99ac0d901ecc"
],
"host_id": [
"B0vzNN8XEc"
],
"nf_edge_router_id.keyword": [
"6b1f9fba-7323-44ab-a0fa-32518d4ba62f"
],
"tags.serviceId.keyword": [
"3x-odLZ-W"
],
"processed": [
1
],
"nf_service_name.keyword": [
"Service 1"
],
"@timestamp": [
"2024-04-09T11:08:30.084Z"
],
"edge_session_id.keyword": [
""
],
"network_id.keyword": [
"3ab6352dd7331-706f-49b1-80c3-678578601234"
],
"namespace": [
"fabric.usage"
],
"source_id": [
"B0vzNN8XEc"
],
"fabric_circuit_id": [
"grIhnaJsc"
]
},
"sort": [
1712660910084
]
}