Skip to content

Latest commit

 

History

History
211 lines (137 loc) · 9.58 KB

LoggingNewrelicApi.md

File metadata and controls

211 lines (137 loc) · 9.58 KB
Raw

LoggingNewrelicApi

Note

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

Method HTTP request Description
create_log_newrelic POST /service/{service_id}/version/{version_id}/logging/newrelic Create a New Relic log endpoint
delete_log_newrelic DELETE /service/{service_id}/version/{version_id}/logging/newrelic/{logging_newrelic_name} Delete a New Relic log endpoint
get_log_newrelic GET /service/{service_id}/version/{version_id}/logging/newrelic/{logging_newrelic_name} Get a New Relic log endpoint
list_log_newrelic GET /service/{service_id}/version/{version_id}/logging/newrelic List New Relic log endpoints
update_log_newrelic PUT /service/{service_id}/version/{version_id}/logging/newrelic/{logging_newrelic_name} Update a New Relic log endpoint

create_log_newrelic

Create a New Relic Logs logging object for a particular service and version.

let cfg = &Configuration::default();
let params = CreateLogNewrelicParams {
    // parameters
};
create_log_newrelic(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 New Relic Logs can ingest. [default to {"timestamp":"%{begin:%Y-%m-%dT%H:%M:%S}t","time_elapsed":"%{time.elapsed.usec}V","is_tls":"%{if(req.is_ssl, "true", "false")}V","client_ip":"%{req.http.Fastly-Client-IP}V","geo_city":"%{client.geo.city}V","geo_country_code":"%{client.geo.country_code}V","request":"%{req.request}V","host":"%{req.http.Fastly-Orig-Host}V","url":"%{json.escape(req.url)}V","request_referer":"%{json.escape(req.http.Referer)}V","request_user_agent":"%{json.escape(req.http.User-Agent)}V","request_accept_language":"%{json.escape(req.http.Accept-Language)}V","request_accept_charset":"%{json.escape(req.http.Accept-Charset)}V","cache_status":"%{regsub(fastly_info.state, "^(HIT-(SYNTH)
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]
token Option<String> The Insert API key from the Account page of your New Relic account. Required.
region Option<String> The region to which to stream logs. [default to US]

Return type

crate::models::LoggingNewrelicResponse

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_newrelic

Delete the New Relic Logs logging object for a particular service and version.

let cfg = &Configuration::default();
let params = DeleteLogNewrelicParams {
    // parameters
};
delete_log_newrelic(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_newrelic_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_newrelic

Get the details of a New Relic Logs logging object for a particular service and version.

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

Return type

crate::models::LoggingNewrelicResponse

Authorization

token

HTTP request headers

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

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

list_log_newrelic

List all of the New Relic Logs logging objects for a particular service and version.

let cfg = &Configuration::default();
let params = ListLogNewrelicParams {
    // parameters
};
list_log_newrelic(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::LoggingNewrelicResponse>

Authorization

token

HTTP request headers

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

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

update_log_newrelic

Update a New Relic Logs logging object for a particular service and version.

let cfg = &Configuration::default();
let params = UpdateLogNewrelicParams {
    // parameters
};
update_log_newrelic(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_newrelic_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 New Relic Logs can ingest. [default to {"timestamp":"%{begin:%Y-%m-%dT%H:%M:%S}t","time_elapsed":"%{time.elapsed.usec}V","is_tls":"%{if(req.is_ssl, "true", "false")}V","client_ip":"%{req.http.Fastly-Client-IP}V","geo_city":"%{client.geo.city}V","geo_country_code":"%{client.geo.country_code}V","request":"%{req.request}V","host":"%{req.http.Fastly-Orig-Host}V","url":"%{json.escape(req.url)}V","request_referer":"%{json.escape(req.http.Referer)}V","request_user_agent":"%{json.escape(req.http.User-Agent)}V","request_accept_language":"%{json.escape(req.http.Accept-Language)}V","request_accept_charset":"%{json.escape(req.http.Accept-Charset)}V","cache_status":"%{regsub(fastly_info.state, "^(HIT-(SYNTH)
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]
token Option<String> The Insert API key from the Account page of your New Relic account. Required.
region Option<String> The region to which to stream logs. [default to Region_US]

Return type

crate::models::LoggingNewrelicResponse

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]