Fastly::LoggingDatadogApi

require 'fastly'
api_instance = Fastly::LoggingDatadogApi.new

Methods

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_log_datadog(opts): <LoggingDatadogResponse> # Create a Datadog log endpoint

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

Examples

api_instance = Fastly::LoggingDatadogApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    version_id: 56, # Integer | Integer identifying a service version.
    name: 'name_example', # String | The name for the real-time logging configuration.
    placement: 'none', # 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: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
    format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Datadog can ingest. 
    format_version: 1, # Integer | 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`. 
    region: 'US', # String | The region that log data will be sent to.
    token: 'token_example', # String | The API key from your Datadog account. Required.
}

begin
  # Create a Datadog log endpoint
  result = api_instance.create_log_datadog(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling LoggingDatadogApi->create_log_datadog: #{e}"
end

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
version_id	Integer	Integer identifying a service version.
name	String	The name for the real-time logging configuration.	[optional]
placement	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`.	[optional]
response_condition	String	The name of an existing condition in the configured endpoint, or leave blank to always execute.	[optional]
format	String	A Fastly log format string. Must produce valid JSON that Datadog can ingest.	[optional][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	Integer	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`.	[optional][default to FORMAT_VERSION::v2]
region	String	The region that log data will be sent to.	[optional][default to 'US']
token	String	The API key from your Datadog account. Required.	[optional]

Return type

LoggingDatadogResponse

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

`delete_log_datadog()`

delete_log_datadog(opts): <InlineResponse200> # Delete a Datadog log endpoint

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

Examples

api_instance = Fastly::LoggingDatadogApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    version_id: 56, # Integer | Integer identifying a service version.
    logging_datadog_name: 'logging_datadog_name_example', # String | The name for the real-time logging configuration.
}

begin
  # Delete a Datadog log endpoint
  result = api_instance.delete_log_datadog(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling LoggingDatadogApi->delete_log_datadog: #{e}"
end

Options

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

Return type

InlineResponse200

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

`get_log_datadog()`

get_log_datadog(opts): <LoggingDatadogResponse> # Get a Datadog log endpoint

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

Examples

api_instance = Fastly::LoggingDatadogApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    version_id: 56, # Integer | Integer identifying a service version.
    logging_datadog_name: 'logging_datadog_name_example', # String | The name for the real-time logging configuration.
}

begin
  # Get a Datadog log endpoint
  result = api_instance.get_log_datadog(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling LoggingDatadogApi->get_log_datadog: #{e}"
end

Options

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

Return type

LoggingDatadogResponse

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

`list_log_datadog()`

list_log_datadog(opts): <Array<LoggingDatadogResponse>> # List Datadog log endpoints

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

Examples

api_instance = Fastly::LoggingDatadogApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    version_id: 56, # Integer | Integer identifying a service version.
}

begin
  # List Datadog log endpoints
  result = api_instance.list_log_datadog(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling LoggingDatadogApi->list_log_datadog: #{e}"
end

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
version_id	Integer	Integer identifying a service version.

Return type

Array<LoggingDatadogResponse>

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

`update_log_datadog()`

update_log_datadog(opts): <LoggingDatadogResponse> # Update a Datadog log endpoint

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

Examples

api_instance = Fastly::LoggingDatadogApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    version_id: 56, # Integer | Integer identifying a service version.
    logging_datadog_name: 'logging_datadog_name_example', # String | The name for the real-time logging configuration.
    name: 'name_example', # String | The name for the real-time logging configuration.
    placement: 'none', # 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: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
    format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Datadog can ingest. 
    format_version: 1, # Integer | 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`. 
    region: 'US', # String | The region that log data will be sent to.
    token: 'token_example', # String | The API key from your Datadog account. Required.
}

begin
  # Update a Datadog log endpoint
  result = api_instance.update_log_datadog(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling LoggingDatadogApi->update_log_datadog: #{e}"
end

Options

Name	Type	Description	Notes
service_id	String	Alphanumeric string identifying the service.
version_id	Integer	Integer identifying a service version.
logging_datadog_name	String	The name for the real-time logging configuration.
name	String	The name for the real-time logging configuration.	[optional]
placement	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`.	[optional]
response_condition	String	The name of an existing condition in the configured endpoint, or leave blank to always execute.	[optional]
format	String	A Fastly log format string. Must produce valid JSON that Datadog can ingest.	[optional][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	Integer	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`.	[optional][default to FORMAT_VERSION::v2]
region	String	The region that log data will be sent to.	[optional][default to 'US']
token	String	The API key from your Datadog account. Required.	[optional]

Return type

LoggingDatadogResponse

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LoggingDatadogApi.md

LoggingDatadogApi.md

Fastly::LoggingDatadogApi

Methods

`create_log_datadog()`

Examples

Options

Return type

`delete_log_datadog()`

Examples

Options

Return type

`get_log_datadog()`

Examples

Options

Return type

`list_log_datadog()`

Examples

Options

Return type

`update_log_datadog()`

Examples

Options

Return type

Files

LoggingDatadogApi.md

Latest commit

History

LoggingDatadogApi.md

File metadata and controls

Fastly::LoggingDatadogApi

Methods

create_log_datadog()

Examples

Options

Return type

delete_log_datadog()

Examples

Options

Return type

get_log_datadog()

Examples

Options

Return type

list_log_datadog()

Examples

Options

Return type

update_log_datadog()

Examples

Options

Return type

`create_log_datadog()`

`delete_log_datadog()`

`get_log_datadog()`

`list_log_datadog()`

`update_log_datadog()`