Skip to content

Latest commit

 

History

History
211 lines (137 loc) · 8.09 KB

LoggingHoneycombApi.md

File metadata and controls

211 lines (137 loc) · 8.09 KB
Raw

LoggingHoneycombApi

Note

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

Method HTTP request Description
create_log_honeycomb POST /service/{service_id}/version/{version_id}/logging/honeycomb Create a Honeycomb log endpoint
delete_log_honeycomb DELETE /service/{service_id}/version/{version_id}/logging/honeycomb/{logging_honeycomb_name} Delete the Honeycomb log endpoint
get_log_honeycomb GET /service/{service_id}/version/{version_id}/logging/honeycomb/{logging_honeycomb_name} Get a Honeycomb log endpoint
list_log_honeycomb GET /service/{service_id}/version/{version_id}/logging/honeycomb List Honeycomb log endpoints
update_log_honeycomb PUT /service/{service_id}/version/{version_id}/logging/honeycomb/{logging_honeycomb_name} Update a Honeycomb log endpoint

create_log_honeycomb

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

let cfg = &Configuration::default();
let params = CreateLogHoneycombParams {
    // parameters
};
create_log_honeycomb(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 Honeycomb can ingest.
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]
dataset Option<String> The Honeycomb Dataset you want to log to.
token Option<String> The Write Key from the Account page of your Honeycomb account.

Return type

crate::models::LoggingHoneycombResponse

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_honeycomb

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

let cfg = &Configuration::default();
let params = DeleteLogHoneycombParams {
    // parameters
};
delete_log_honeycomb(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_honeycomb_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_honeycomb

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

let cfg = &Configuration::default();
let params = GetLogHoneycombParams {
    // parameters
};
get_log_honeycomb(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_honeycomb_name String The name for the real-time logging configuration. [required]

Return type

crate::models::LoggingHoneycombResponse

Authorization

token

HTTP request headers

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

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

list_log_honeycomb

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

let cfg = &Configuration::default();
let params = ListLogHoneycombParams {
    // parameters
};
list_log_honeycomb(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::LoggingHoneycombResponse>

Authorization

token

HTTP request headers

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

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

update_log_honeycomb

Update a Honeycomb logging object for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateLogHoneycombParams {
    // parameters
};
update_log_honeycomb(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_honeycomb_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 Honeycomb can ingest.
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]
dataset Option<String> The Honeycomb Dataset you want to log to.
token Option<String> The Write Key from the Account page of your Honeycomb account.

Return type

crate::models::LoggingHoneycombResponse

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]