Skip to content

Latest commit

 

History

History
211 lines (137 loc) · 13.8 KB

LoggingDatadogApi.md

File metadata and controls

211 lines (137 loc) · 13.8 KB

LoggingDatadogApi

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
create_log_datadog POST /service/{service_id}/version/{version_id}/logging/datadog Create a Datadog log endpoint
delete_log_datadog DELETE /service/{service_id}/version/{version_id}/logging/datadog/{logging_datadog_name} Delete a Datadog log endpoint
get_log_datadog GET /service/{service_id}/version/{version_id}/logging/datadog/{logging_datadog_name} Get a Datadog log endpoint
list_log_datadog GET /service/{service_id}/version/{version_id}/logging/datadog List Datadog log endpoints
update_log_datadog PUT /service/{service_id}/version/{version_id}/logging/datadog/{logging_datadog_name} Update a Datadog log endpoint

create_log_datadog

Create a Datadog logging object for a particular service and version.

let cfg = &Configuration::default();
let params = CreateLogDatadogParams {
    // parameters
};
create_log_datadog(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
name Option<String> The name for the real-time logging configuration.
placement Option<String> Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver.
response_condition Option<String> The name of an existing condition in the configured endpoint, or leave blank to always execute.
format Option<String> A Fastly log format string. Must produce valid JSON that Datadog can ingest. [default to {"ddsource":"fastly","service":"%{req.service_id}V","date":"%{begin:%Y-%m-%dT%H:%M:%S%Z}t","time_start":"%{begin:%Y-%m-%dT%H:%M:%S%Z}t","time_end":"%{end:%Y-%m-%dT%H:%M:%S%Z}t","http":{"request_time_ms":"%D","method":"%m","url":"%{json.escape(req.url)}V","useragent":"%{User-Agent}i","referer":"%{Referer}i","protocol":"%H","request_x_forwarded_for":"%{X-Forwarded-For}i","status_code":"%s"},"network":{"client":{"ip":"%h","name":"%{client.as.name}V","number":"%{client.as.number}V","connection_speed":"%{client.geo.conn_speed}V"},"destination":{"ip":"%A"},"geoip":{"geo_city":"%{client.geo.city.utf8}V","geo_country_code":"%{client.geo.country_code}V","geo_continent_code":"%{client.geo.continent_code}V","geo_region":"%{client.geo.region}V"},"bytes_written":"%B","bytes_read":"%{req.body_bytes_read}V"},"host":"%{Fastly-Orig-Host}i","origin_host":"%v","is_ipv6":"%{if(req.is_ipv6, "true", "false")}V","is_tls":"%{if(req.is_ssl, "true", "false")}V","tls_client_protocol":"%{json.escape(tls.client.protocol)}V","tls_client_servername":"%{json.escape(tls.client.servername)}V","tls_client_cipher":"%{json.escape(tls.client.cipher)}V","tls_client_cipher_sha":"%{json.escape(tls.client.ciphers_sha)}V","tls_client_tlsexts_sha":"%{json.escape(tls.client.tlsexts_sha)}V","is_h2":"%{if(fastly_info.is_h2, "true", "false")}V","is_h2_push":"%{if(fastly_info.h2.is_push, "true", "false")}V","h2_stream_id":"%{fastly_info.h2.stream_id}V","request_accept_content":"%{Accept}i","request_accept_language":"%{Accept-Language}i","request_accept_encoding":"%{Accept-Encoding}i","request_accept_charset":"%{Accept-Charset}i","request_connection":"%{Connection}i","request_dnt":"%{DNT}i","request_forwarded":"%{Forwarded}i","request_via":"%{Via}i","request_cache_control":"%{Cache-Control}i","request_x_requested_with":"%{X-Requested-With}i","request_x_att_device_id":"%{X-ATT-Device-Id}i","content_type":"%{Content-Type}o","is_cacheable":"%{if(fastly_info.state~"^(HIT
format_version Option<i32> The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. [default to FormatVersion_v2]
region Option<String> The region that log data will be sent to. [default to US]
token Option<String> The API key from your Datadog account. Required.

Return type

crate::models::LoggingDatadogResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

delete_log_datadog

Delete the Datadog logging object for a particular service and version.

let cfg = &Configuration::default();
let params = DeleteLogDatadogParams {
    // parameters
};
delete_log_datadog(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
logging_datadog_name String The name for the real-time logging configuration. [required]

Return type

crate::models::InlineResponse200

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

get_log_datadog

Get the details for a Datadog logging object for a particular service and version.

let cfg = &Configuration::default();
let params = GetLogDatadogParams {
    // parameters
};
get_log_datadog(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
logging_datadog_name String The name for the real-time logging configuration. [required]

Return type

crate::models::LoggingDatadogResponse

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

list_log_datadog

List all of the Datadog logging objects for a particular service and version.

let cfg = &Configuration::default();
let params = ListLogDatadogParams {
    // parameters
};
list_log_datadog(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]

Return type

Vec<crate::models::LoggingDatadogResponse>

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

update_log_datadog

Update the Datadog logging object for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateLogDatadogParams {
    // parameters
};
update_log_datadog(cfg, params)

Parameters

Name Type Description Required Notes
service_id String Alphanumeric string identifying the service. [required]
version_id i32 Integer identifying a service version. [required]
logging_datadog_name String The name for the real-time logging configuration. [required]
name Option<String> The name for the real-time logging configuration.
placement Option<String> Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver.
response_condition Option<String> The name of an existing condition in the configured endpoint, or leave blank to always execute.
format Option<String> A Fastly log format string. Must produce valid JSON that Datadog can ingest. [default to {"ddsource":"fastly","service":"%{req.service_id}V","date":"%{begin:%Y-%m-%dT%H:%M:%S%Z}t","time_start":"%{begin:%Y-%m-%dT%H:%M:%S%Z}t","time_end":"%{end:%Y-%m-%dT%H:%M:%S%Z}t","http":{"request_time_ms":"%D","method":"%m","url":"%{json.escape(req.url)}V","useragent":"%{User-Agent}i","referer":"%{Referer}i","protocol":"%H","request_x_forwarded_for":"%{X-Forwarded-For}i","status_code":"%s"},"network":{"client":{"ip":"%h","name":"%{client.as.name}V","number":"%{client.as.number}V","connection_speed":"%{client.geo.conn_speed}V"},"destination":{"ip":"%A"},"geoip":{"geo_city":"%{client.geo.city.utf8}V","geo_country_code":"%{client.geo.country_code}V","geo_continent_code":"%{client.geo.continent_code}V","geo_region":"%{client.geo.region}V"},"bytes_written":"%B","bytes_read":"%{req.body_bytes_read}V"},"host":"%{Fastly-Orig-Host}i","origin_host":"%v","is_ipv6":"%{if(req.is_ipv6, "true", "false")}V","is_tls":"%{if(req.is_ssl, "true", "false")}V","tls_client_protocol":"%{json.escape(tls.client.protocol)}V","tls_client_servername":"%{json.escape(tls.client.servername)}V","tls_client_cipher":"%{json.escape(tls.client.cipher)}V","tls_client_cipher_sha":"%{json.escape(tls.client.ciphers_sha)}V","tls_client_tlsexts_sha":"%{json.escape(tls.client.tlsexts_sha)}V","is_h2":"%{if(fastly_info.is_h2, "true", "false")}V","is_h2_push":"%{if(fastly_info.h2.is_push, "true", "false")}V","h2_stream_id":"%{fastly_info.h2.stream_id}V","request_accept_content":"%{Accept}i","request_accept_language":"%{Accept-Language}i","request_accept_encoding":"%{Accept-Encoding}i","request_accept_charset":"%{Accept-Charset}i","request_connection":"%{Connection}i","request_dnt":"%{DNT}i","request_forwarded":"%{Forwarded}i","request_via":"%{Via}i","request_cache_control":"%{Cache-Control}i","request_x_requested_with":"%{X-Requested-With}i","request_x_att_device_id":"%{X-ATT-Device-Id}i","content_type":"%{Content-Type}o","is_cacheable":"%{if(fastly_info.state~"^(HIT
format_version Option<i32> The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. [default to FormatVersion_v2]
region Option<String> The region that log data will be sent to. [default to Region_US]
token Option<String> The API key from your Datadog account. Required.

Return type

crate::models::LoggingDatadogResponse

Authorization

token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]