The length of time for which monitor sample data is aggregated.
type
string
alias
description
Alias of the upstream server.
type
string
app
description
The name of an application. Application names are unique within the environment namespace where the app resides.
type
string
component
description
The name of an application component.
type
string
country_code
description
The ISO 3166-1 representation of the country from which a request was sent.
type
string
environment
description
Environment of the application.
type
string
family
description
Logical group to which the highest layer protocol processed by the proxy belongs. Allowed values are 'web' and 'tcp-udp'
type
string
file_path
description
Path to a desired file.
type
string
gateway
description
The name of gateway. The gateway can be shared across applications.
type
string
http.hostname
description
Hostname as provided in the 'Host' header field from client's request.
type
string
http.request_method
description
The HTTP method of the request. For example, 'GET', 'POST', 'PUT'.
type
string
http.response_code
description
The 3-digit HTTP response status code. For example, '200', '404', '302'.
type
string
http.upstream_addr
description
The IP address and port, or the path to the UNIX-domain socket, of the upstream server.
type
string
http.uri
description
The URI (path) section of the URL in a request.
type
string
http.version_schema
description
A version schema.
type
string
instance
description
The name of the NGINX Plus instance where the upstream server is running.
type
string
instance.tags
description
The tags associated with the NGINX Plus instance where the upstream server is running.
type
string
instance_group
description
The name of the NGINX instance group to manage set of instances that can be used for scaling and high availability.
type
string
local_id
description
local_id dimension.
type
string
location
description
A location associated with one or more NGINX Plus instances.
type
string
log_filter
description
The user-defined filter provided in a metrics query.
type
string
mount_point
description
A filesystem mount point.
type
string
network_interface
description
A server network interface.
type
string
parent_hostname
description
The hostname of the NGINX Plus instance.
type
string
proxied_protocol
description
Highest layer protocol that the proxy processes. Allowed values are: 'http', 'tcp', and 'udp'
type
string
published_api
description
A Published API in the API Management module.
type
string
request_outcome
description
Indicates whether the traffic was allowed to go through or was blocked by the firewall.
type
string
request_outcome_reason
description
The reason why the firewall blocked the traffic.
type
string
root_uuid
description
The unique identifier of the operating system where the Controller Agent is installed.
type
string
upstream_addr
description
Address of the upstream server
type
string
upstream_response_code
description
The 3-digit HTTP response status code sent by the upstream server. For example, '200', '404', '302'.
type
string
waf.attack_types
description
A list of comma separated names of suspected attacks identified in a transaction.
type
string
waf.signature_ids
description
Value of the matching signatures that resulted in the security violation.
type
string
waf.violation_rating
description
The likelihood that the security violation is indeed a threat.
type
string
waf.violation_subviolations
description
The additional granularity of security violation that causes the traffic was blocked or flagged by the firewall.
type
string
waf.violations
description
The security violation that causes the traffic was blocked or flagged by the firewall.
type
string
This documentation applies to the following versions of NGINX Controller Documentation: 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 3.12, 3.13, 3.14, 3.15 and 3.16.