Skip to main content

network_health_insights

Creates, updates, deletes, gets or lists a network_health_insights resource.

Overview

Namenetwork_health_insights
TypeResource
Iddatadog.infrastructure.network_health_insights

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringUnique identifier for this network health insight. (example: example-insight-id)
attributesobjectDetailed attributes of a network health insight.
typestringThe resource type for network health insights. Always network-health-insights. (network-health-insights) (default: network-health-insights, example: network-health-insights)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_network_health_insightsselectfrom, toReturn network health insights for the organization within the given time window.<br />Insights are produced by analyzing DNS failures pre-classified by network-dns-logger,<br />TLS certificate metrics, and denied security group connections. Each insight<br />identifies the client and server services involved, the type of issue, and the<br />magnitude of the failure observed during the query window.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
sitestringThe Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
fromstringUnix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the to timestamp. If neither from nor to are provided, the query window will be &#91;now - 15m, now&#93;. (example: 1716800000)
tostringUnix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be the current time. If neither from nor to are provided, the query window will be &#91;now - 15m, now&#93;. (example: 1716800900)

SELECT examples

Return network health insights for the organization within the given time window.<br />Insights are produced by analyzing DNS failures pre-classified by network-dns-logger,<br />TLS certificate metrics, and denied security group connections. Each insight<br />identifies the client and server services involved, the type of issue, and the<br />magnitude of the failure observed during the query window.

SELECT
id,
attributes,
type
FROM datadog.infrastructure.network_health_insights
WHERE from = '{{ from }}'
AND to = '{{ to }}'
;