fastly.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

LoggingNewrelicResponse create_log_newrelic(service_id, version_id)

Create a New Relic log endpoint

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

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_newrelic_api
from fastly.model.logging_newrelic_response import LoggingNewrelicResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_newrelic_api.LoggingNewrelicApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    name = "test-log-endpoint" # str | The name for the real-time logging configuration. (optional)
    placement = "none" # str, none_type | 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 = "response_condition_example" # str, none_type | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format = "{"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)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that New Relic Logs can ingest. (optional) if omitted the server will use the default value of "{"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)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}"
    format_version = 2 # int | 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) if omitted the server will use the default value of 2
    token = "token_example" # str | The Insert API key from the Account page of your New Relic account. Required. (optional)
    region = "US" # str | The region to which to stream logs. (optional) if omitted the server will use the default value of "US"

    # example passing only required values which don't have defaults set
    try:
        # Create a New Relic log endpoint
        api_response = api_instance.create_log_newrelic(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingNewrelicApi->create_log_newrelic: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a New Relic log endpoint
        api_response = api_instance.create_log_newrelic(service_id, version_id, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, token=token, region=region)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingNewrelicApi->create_log_newrelic: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
name	str	The name for the real-time logging configuration.	[optional]
placement	str, none_type	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	str, none_type	The name of an existing condition in the configured endpoint, or leave blank to always execute.	[optional]
format	str	A Fastly log format string. Must produce valid JSON that New Relic Logs can ingest.	[optional] if omitted the server will use the default value of "{"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	int	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] if omitted the server will use the default value of 2
token	str	The Insert API key from the Account page of your New Relic account. Required.	[optional]
region	str	The region to which to stream logs.	[optional] if omitted the server will use the default value of "US"

Return type

LoggingNewrelicResponse

Authorization

token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

delete_log_newrelic

InlineResponse200 delete_log_newrelic(service_id, version_id, logging_newrelic_name)

Delete a New Relic log endpoint

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

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_newrelic_api
from fastly.model.inline_response200 import InlineResponse200
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_newrelic_api.LoggingNewrelicApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_newrelic_name = "test-log-endpoint" # str | The name for the real-time logging configuration.

    # example passing only required values which don't have defaults set
    try:
        # Delete a New Relic log endpoint
        api_response = api_instance.delete_log_newrelic(service_id, version_id, logging_newrelic_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingNewrelicApi->delete_log_newrelic: %s\n" % e)

Parameters

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

Return type

InlineResponse200

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

get_log_newrelic

LoggingNewrelicResponse get_log_newrelic(service_id, version_id, logging_newrelic_name)

Get a New Relic log endpoint

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

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_newrelic_api
from fastly.model.logging_newrelic_response import LoggingNewrelicResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_newrelic_api.LoggingNewrelicApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_newrelic_name = "test-log-endpoint" # str | The name for the real-time logging configuration.

    # example passing only required values which don't have defaults set
    try:
        # Get a New Relic log endpoint
        api_response = api_instance.get_log_newrelic(service_id, version_id, logging_newrelic_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingNewrelicApi->get_log_newrelic: %s\n" % e)

Parameters

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

Return type

LoggingNewrelicResponse

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

list_log_newrelic

[LoggingNewrelicResponse] list_log_newrelic(service_id, version_id)

List New Relic log endpoints

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

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_newrelic_api
from fastly.model.logging_newrelic_response import LoggingNewrelicResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_newrelic_api.LoggingNewrelicApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.

    # example passing only required values which don't have defaults set
    try:
        # List New Relic log endpoints
        api_response = api_instance.list_log_newrelic(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingNewrelicApi->list_log_newrelic: %s\n" % e)

Parameters

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

Return type

[LoggingNewrelicResponse]

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

update_log_newrelic

LoggingNewrelicResponse update_log_newrelic(service_id, version_id, logging_newrelic_name)

Update a New Relic log endpoint

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

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_newrelic_api
from fastly.model.logging_newrelic_response import LoggingNewrelicResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_newrelic_api.LoggingNewrelicApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_newrelic_name = "test-log-endpoint" # str | The name for the real-time logging configuration.
    name = "test-log-endpoint" # str | The name for the real-time logging configuration. (optional)
    placement = "none" # str, none_type | 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 = "response_condition_example" # str, none_type | The name of an existing condition in the configured endpoint, or leave blank to always execute. (optional)
    format = "{"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)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that New Relic Logs can ingest. (optional) if omitted the server will use the default value of "{"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)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}"
    format_version = 2 # int | 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) if omitted the server will use the default value of 2
    token = "token_example" # str | The Insert API key from the Account page of your New Relic account. Required. (optional)
    region = "US" # str | The region to which to stream logs. (optional) if omitted the server will use the default value of "US"

    # example passing only required values which don't have defaults set
    try:
        # Update a New Relic log endpoint
        api_response = api_instance.update_log_newrelic(service_id, version_id, logging_newrelic_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingNewrelicApi->update_log_newrelic: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update a New Relic log endpoint
        api_response = api_instance.update_log_newrelic(service_id, version_id, logging_newrelic_name, name=name, placement=placement, response_condition=response_condition, format=format, format_version=format_version, token=token, region=region)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingNewrelicApi->update_log_newrelic: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_newrelic_name	str	The name for the real-time logging configuration.
name	str	The name for the real-time logging configuration.	[optional]
placement	str, none_type	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	str, none_type	The name of an existing condition in the configured endpoint, or leave blank to always execute.	[optional]
format	str	A Fastly log format string. Must produce valid JSON that New Relic Logs can ingest.	[optional] if omitted the server will use the default value of "{"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	int	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] if omitted the server will use the default value of 2
token	str	The Insert API key from the Account page of your New Relic account. Required.	[optional]
region	str	The region to which to stream logs.	[optional] if omitted the server will use the default value of "US"

Return type

LoggingNewrelicResponse

Authorization

token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

Files

LoggingNewrelicApi.md

Latest commit

History

LoggingNewrelicApi.md

File metadata and controls

fastly.LoggingNewrelicApi

create_log_newrelic

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_log_newrelic

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_log_newrelic

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_log_newrelic

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_log_newrelic

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details