AttributeVocabulary (Snowdrop :: Istio Java API

java.lang.Object
- me.snowdrop.istio.api.cexl.AttributeVocabulary

public class AttributeVocabulary
extends Object

Author:: Christophe Laprun

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AttributeVocabulary.AttributeInfo

Nested Classes
Modifier and Type	Class and Description
`static class`	`AttributeVocabulary.AttributeInfo`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`api_operation` api.operation attribute with expected type: string Unique string used to identify the operation.
`static String`	`api_protocol` api.protocol attribute with expected type: string The protocol type of the API call.
`static String`	`api_service` api.service attribute with expected type: string The public service name.
`static String`	`api_version` api.version attribute with expected type: string The API version.
`static String`	`check_error_code` check.error_code attribute with expected type: int64 The error [code](https://github.com/google/protobuf/blob/master/src/google/protobuf/stubs/status.h#L44) for Mixer Check call.
`static String`	`check_error_message` check.error_message attribute with expected type: string The error message for Mixer Check call.
`static String`	`connection_duration` connection.duration attribute with expected type: duration The total amount of time a connection has been open.
`static String`	`connection_id` connection.id attribute with expected type: string An ID for a TCP connection with statistically low probability of collision.
`static String`	`connection_received_bytes` connection.received.bytes attribute with expected type: int64 Number of bytes received by a destination service on a connection since the last Report() for a connection.
`static String`	`connection_received_bytes_total` connection.received.bytes_total attribute with expected type: int64 Total number of bytes received by a destination service during the lifetime of a connection.
`static String`	`connection_sent_bytes` connection.sent.bytes attribute with expected type: int64 Number of bytes sent by a destination service on a connection since the last Report() for a connection.
`static String`	`connection_sent_bytes_total` connection.sent.bytes_total attribute with expected type: int64 Total number of bytes sent by a destination service during the lifetime of a connection.
`static String`	`context_protocol` context.protocol attribute with expected type: string Protocol of the request or connection being proxied.
`static String`	`context_time` context.time attribute with expected type: timestamp The timestamp of Mixer operation.
`static String`	`destination_domain` destination.domain attribute with expected type: string The domain suffix part of the destination service, excluding the name and the namespace.
`static String`	`destination_ip` destination.ip attribute with expected type: ip_address Server IP address.
`static String`	`destination_labels` destination.labels attribute with expected type: map[string, string] A map of key-value pairs attached to the server instance.
`static String`	`destination_name` destination.name attribute with expected type: string The short name part of the destination service.
`static String`	`destination_namespace` destination.namespace attribute with expected type: string The namespace part of the destination service.
`static String`	`destination_port` destination.port attribute with expected type: int64 The recipient port on the server IP address.
`static String`	`destination_service` destination.service attribute with expected type: string The fully qualified name of the service that the server belongs to.
`static String`	`destination_uid` destination.uid attribute with expected type: string Platform-specific unique identifier for the server instance of the destination service.
`static String`	`destination_user` destination.user attribute with expected type: string The user running the destination application.
`static String`	`request_api_key` request.api_key attribute with expected type: string The API key used for the request.
`static String`	`request_auth_audiences` request.auth.audiences attribute with expected type: string The intended audience(s) for this authentication information.
`static String`	`request_auth_presenter` request.auth.presenter attribute with expected type: string The authorized presenter of the credential.
`static String`	`request_auth_principal` request.auth.principal attribute with expected type: string The authenticated principal of the request.
`static String`	`request_headers` request.headers attribute with expected type: map[string, string] HTTP request headers.
`static String`	`request_host` request.host attribute with expected type: string HTTP/1.x host header or HTTP/2 authority header.
`static String`	`request_id` request.id attribute with expected type: string An ID for the request with statistically low probability of collision.
`static String`	`request_method` request.method attribute with expected type: string The HTTP method.
`static String`	`request_path` request.path attribute with expected type: string The HTTP URL path including query string Example:
`static String`	`request_reason` request.reason attribute with expected type: string The request reason used by auditing systems.
`static String`	`request_referer` request.referer attribute with expected type: string The HTTP referer header.
`static String`	`request_scheme` request.scheme attribute with expected type: string URI Scheme of the request Example:
`static String`	`request_size` request.size attribute with expected type: int64 Size of the request in bytes.
`static String`	`request_time` request.time attribute with expected type: timestamp The timestamp when the destination receives the request.
`static String`	`request_useragent` request.useragent attribute with expected type: string The HTTP User-Agent header.
`static String`	`response_code` response.code attribute with expected type: int64 The response's HTTP status code.
`static String`	`response_duration` response.duration attribute with expected type: duration The amount of time the response took to generate.
`static String`	`response_headers` response.headers attribute with expected type: map[string, string] HTTP response headers.
`static String`	`response_size` response.size attribute with expected type: int64 Size of the response body in bytes Example:
`static String`	`response_time` response.time attribute with expected type: timestamp The timestamp when the destination produced the response.
`static String`	`source_domain` source.domain attribute with expected type: string The domain suffix part of the source service, excluding the name and the namespace.
`static String`	`source_ip` source.ip attribute with expected type: ip_address Client IP address.
`static String`	`source_labels` source.labels attribute with expected type: map[string, string] A map of key-value pairs attached to the client instance.
`static String`	`source_name` source.name attribute with expected type: string The short name part of the source service.
`static String`	`source_namespace` source.namespace attribute with expected type: string The namespace part of the source service.
`static String`	`source_service` source.service attribute with expected type: string The fully qualified name of the service that the client belongs to.
`static String`	`source_uid` source.uid attribute with expected type: string Platform-specific unique identifier for the client instance of the source service.
`static String`	`source_user` source.user attribute with expected type: string The identity of the immediate sender of the request, authenticated by mTLS.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Optional<AttributeVocabulary.AttributeInfo>`	`getInfoFor(String attributeName)`
`static Set<String>`	`getKnownAttributes()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - source_ip
```
public static final String source_ip
```
    source.ip attribute with expected type: ip_address Client IP address. Example: 10.0.0.117
    
    See Also:
    
    Constant Field Values
  - source_service
```
public static final String source_service
```
    source.service attribute with expected type: string The fully qualified name of the service that the client belongs to. Example: redis-master.my-namespace.svc.cluster.local
    
    See Also:
    
    Constant Field Values
  - source_name
```
public static final String source_name
```
    source.name attribute with expected type: string The short name part of the source service. Example: redis-master
    
    See Also:
    
    Constant Field Values
  - source_namespace
```
public static final String source_namespace
```
    source.namespace attribute with expected type: string The namespace part of the source service. Example: my-namespace
    
    See Also:
    
    Constant Field Values
  - source_domain
```
public static final String source_domain
```
    source.domain attribute with expected type: string The domain suffix part of the source service, excluding the name and the namespace. Example: svc.cluster.local
    
    See Also:
    
    Constant Field Values
  - source_uid
```
public static final String source_uid
```
    source.uid attribute with expected type: string Platform-specific unique identifier for the client instance of the source service. Example: kubernetes://redis-master-2353460263-1ecey.my-namespace
    
    See Also:
    
    Constant Field Values
  - source_labels
```
public static final String source_labels
```
    source.labels attribute with expected type: map[string, string] A map of key-value pairs attached to the client instance. Example: version => v1
    
    See Also:
    
    Constant Field Values
  - source_user
```
public static final String source_user
```
    source.user attribute with expected type: string The identity of the immediate sender of the request, authenticated by mTLS. Example: service-account-foo
    
    See Also:
    
    Constant Field Values
  - destination_ip
```
public static final String destination_ip
```
    destination.ip attribute with expected type: ip_address Server IP address. Example: 10.0.0.104
    
    See Also:
    
    Constant Field Values
  - destination_port
```
public static final String destination_port
```
    destination.port attribute with expected type: int64 The recipient port on the server IP address. Example: 8080
    
    See Also:
    
    Constant Field Values
  - destination_service
```
public static final String destination_service
```
    destination.service attribute with expected type: string The fully qualified name of the service that the server belongs to. Example: my-svc.my-namespace.svc.cluster.local
    
    See Also:
    
    Constant Field Values
  - destination_name
```
public static final String destination_name
```
    destination.name attribute with expected type: string The short name part of the destination service. Example: my-svc
    
    See Also:
    
    Constant Field Values
  - destination_namespace
```
public static final String destination_namespace
```
    destination.namespace attribute with expected type: string The namespace part of the destination service. Example: my-namespace
    
    See Also:
    
    Constant Field Values
  - destination_domain
```
public static final String destination_domain
```
    destination.domain attribute with expected type: string The domain suffix part of the destination service, excluding the name and the namespace. Example: svc.cluster.local
    
    See Also:
    
    Constant Field Values
  - destination_uid
```
public static final String destination_uid
```
    destination.uid attribute with expected type: string Platform-specific unique identifier for the server instance of the destination service. Example: kubernetes://my-svc-234443-5sffe.my-namespace
    
    See Also:
    
    Constant Field Values
  - destination_labels
```
public static final String destination_labels
```
    destination.labels attribute with expected type: map[string, string] A map of key-value pairs attached to the server instance. Example: version => v2
    
    See Also:
    
    Constant Field Values
  - destination_user
```
public static final String destination_user
```
    destination.user attribute with expected type: string The user running the destination application. Example: service-account
    
    See Also:
    
    Constant Field Values
  - request_headers
```
public static final String request_headers
```
    request.headers attribute with expected type: map[string, string] HTTP request headers. For gRPC, its metadata will be here. Example:
    
    See Also:
    
    Constant Field Values
  - request_id
```
public static final String request_id
```
    request.id attribute with expected type: string An ID for the request with statistically low probability of collision. Example:
    
    See Also:
    
    Constant Field Values
  - request_path
```
public static final String request_path
```
    request.path attribute with expected type: string The HTTP URL path including query string Example:
    
    See Also:
    
    Constant Field Values
  - request_host
```
public static final String request_host
```
    request.host attribute with expected type: string HTTP/1.x host header or HTTP/2 authority header. Example: redis-master:3337
    
    See Also:
    
    Constant Field Values
  - request_method
```
public static final String request_method
```
    request.method attribute with expected type: string The HTTP method. Example:
    
    See Also:
    
    Constant Field Values
  - request_reason
```
public static final String request_reason
```
    request.reason attribute with expected type: string The request reason used by auditing systems. Example:
    
    See Also:
    
    Constant Field Values
  - request_referer
```
public static final String request_referer
```
    request.referer attribute with expected type: string The HTTP referer header. Example:
    
    See Also:
    
    Constant Field Values
  - request_scheme
```
public static final String request_scheme
```
    request.scheme attribute with expected type: string URI Scheme of the request Example:
    
    See Also:
    
    Constant Field Values
  - request_size
```
public static final String request_size
```
    request.size attribute with expected type: int64 Size of the request in bytes. For HTTP requests this is equivalent to the Content-Length header. Example:
    
    See Also:
    
    Constant Field Values
  - request_time
```
public static final String request_time
```
    request.time attribute with expected type: timestamp The timestamp when the destination receives the request. This should be equivalent to Firebase "now". Example:
    
    See Also:
    
    Constant Field Values
  - request_useragent
```
public static final String request_useragent
```
    request.useragent attribute with expected type: string The HTTP User-Agent header. Example:
    
    See Also:
    
    Constant Field Values
  - response_headers
```
public static final String response_headers
```
    response.headers attribute with expected type: map[string, string] HTTP response headers. Example:
    
    See Also:
    
    Constant Field Values
  - response_size
```
public static final String response_size
```
    response.size attribute with expected type: int64 Size of the response body in bytes Example:
    
    See Also:
    
    Constant Field Values
  - response_time
```
public static final String response_time
```
    response.time attribute with expected type: timestamp The timestamp when the destination produced the response. Example:
    
    See Also:
    
    Constant Field Values
  - response_duration
```
public static final String response_duration
```
    response.duration attribute with expected type: duration The amount of time the response took to generate. Example:
    
    See Also:
    
    Constant Field Values
  - response_code
```
public static final String response_code
```
    response.code attribute with expected type: int64 The response's HTTP status code. Example:
    
    See Also:
    
    Constant Field Values
  - connection_id
```
public static final String connection_id
```
    connection.id attribute with expected type: string An ID for a TCP connection with statistically low probability of collision. Example:
    
    See Also:
    
    Constant Field Values
  - connection_received_bytes
```
public static final String connection_received_bytes
```
    connection.received.bytes attribute with expected type: int64 Number of bytes received by a destination service on a connection since the last Report() for a connection. Example:
    
    See Also:
    
    Constant Field Values
  - connection_received_bytes_total
```
public static final String connection_received_bytes_total
```
    connection.received.bytes_total attribute with expected type: int64 Total number of bytes received by a destination service during the lifetime of a connection. Example:
    
    See Also:
    
    Constant Field Values
  - connection_sent_bytes
```
public static final String connection_sent_bytes
```
    connection.sent.bytes attribute with expected type: int64 Number of bytes sent by a destination service on a connection since the last Report() for a connection. Example:
    
    See Also:
    
    Constant Field Values
  - connection_sent_bytes_total
```
public static final String connection_sent_bytes_total
```
    connection.sent.bytes_total attribute with expected type: int64 Total number of bytes sent by a destination service during the lifetime of a connection. Example:
    
    See Also:
    
    Constant Field Values
  - connection_duration
```
public static final String connection_duration
```
    connection.duration attribute with expected type: duration The total amount of time a connection has been open. Example:
    
    See Also:
    
    Constant Field Values
  - context_protocol
```
public static final String context_protocol
```
    context.protocol attribute with expected type: string Protocol of the request or connection being proxied. Example: tcp
    
    See Also:
    
    Constant Field Values
  - context_time
```
public static final String context_time
```
    context.time attribute with expected type: timestamp The timestamp of Mixer operation. Example:
    
    See Also:
    
    Constant Field Values
  - api_service
```
public static final String api_service
```
    api.service attribute with expected type: string The public service name. This is different than the in-mesh service identity and reflects the name of the service exposed to the client. Example: my-svc.com
    
    See Also:
    
    Constant Field Values
  - api_version
```
public static final String api_version
```
    api.version attribute with expected type: string The API version. Example: v1alpha1
    
    See Also:
    
    Constant Field Values
  - api_operation
```
public static final String api_operation
```
    api.operation attribute with expected type: string Unique string used to identify the operation. The id is unique among all operations described in a specific <service, version>. Example: getPetsById
    
    See Also:
    
    Constant Field Values
  - api_protocol
```
public static final String api_protocol
```
    api.protocol attribute with expected type: string The protocol type of the API call. Mainly for monitoring/analytics. Note that this is the frontend protocol exposed to the client, not the protocol implemented by the backend service. Example: "http", "https", or "grpc"
    
    See Also:
    
    Constant Field Values
  - request_auth_principal
```
public static final String request_auth_principal
```
    request.auth.principal attribute with expected type: string The authenticated principal of the request. This is a string of the issuer (`iss`) and subject (`sub`) claims within a JWT concatenated with "/" with a percent-encoded subject value. Example: accounts.my-svc.com/104958560606
    
    See Also:
    
    Constant Field Values
  - request_auth_audiences
```
public static final String request_auth_audiences
```
    request.auth.audiences attribute with expected type: string The intended audience(s) for this authentication information. This should reflect the audience (`aud`) claim within a JWT. Example: ['my-svc.com', 'scopes/read']
    
    See Also:
    
    Constant Field Values
  - request_auth_presenter
```
public static final String request_auth_presenter
```
    request.auth.presenter attribute with expected type: string The authorized presenter of the credential. This value should reflect the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth2 client id. Example: 123456789012.my-svc.com
    
    See Also:
    
    Constant Field Values
  - request_api_key
```
public static final String request_api_key
```
    request.api_key attribute with expected type: string The API key used for the request. Example: abcde12345
    
    See Also:
    
    Constant Field Values
  - check_error_code
```
public static final String check_error_code
```
    check.error_code attribute with expected type: int64 The error [code](https://github.com/google/protobuf/blob/master/src/google/protobuf/stubs/status.h#L44) for Mixer Check call. Example: 5
    
    See Also:
    
    Constant Field Values
  - check_error_message
```
public static final String check_error_message
```
    check.error_message attribute with expected type: string The error message for Mixer Check call. Example: Could not find the resource
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInfoFor
```
public static Optional<AttributeVocabulary.AttributeInfo> getInfoFor(String attributeName)
```
  - getKnownAttributes
```
public static Set<String> getKnownAttributes()
```

Class AttributeVocabulary

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

source_ip

source_service

source_name

source_namespace

source_domain

source_uid

source_labels

source_user

destination_ip

destination_port

destination_service

destination_name

destination_namespace

destination_domain

destination_uid

destination_labels

destination_user

request_headers

request_id

request_path

request_host

request_method

request_reason

request_referer

request_scheme

request_size

request_time

request_useragent

response_headers

response_size

response_time

response_duration

response_code

connection_id

connection_received_bytes

connection_received_bytes_total

connection_sent_bytes

connection_sent_bytes_total

connection_duration

context_protocol

context_time

api_service

api_version

api_operation

api_protocol

request_auth_principal

request_auth_audiences

request_auth_presenter

request_api_key

check_error_code

check_error_message

Method Detail

getInfoFor

getKnownAttributes