Skip to content

Latest commit

 

History

History
246 lines (186 loc) · 12.7 KB

LoggingKafkaApi.md

File metadata and controls

246 lines (186 loc) · 12.7 KB
Raw

Fastly\Api\LoggingKafkaApi

$apiInstance = new Fastly\Api\LoggingKafkaApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

Methods

Method Fastly API endpoint Description
createLogKafka() POST /service/{service_id}/version/{version_id}/logging/kafka Create a Kafka log endpoint
deleteLogKafka() DELETE /service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name} Delete the Kafka log endpoint
getLogKafka() GET /service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name} Get a Kafka log endpoint
listLogKafka() GET /service/{service_id}/version/{version_id}/logging/kafka List Kafka log endpoints
updateLogKafka() PUT /service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name} Update the Kafka log endpoint

createLogKafka()

createLogKafka($options): \Fastly\Model\LoggingKafkaResponsePost // Create a Kafka log endpoint

Create a Kafka logging endpoint for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['name'] = 'name_example'; // string | The name for the real-time logging configuration.
$options['placement'] = 'placement_example'; // 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`.
$options['response_condition'] = 'response_condition_example'; // string | The name of an existing condition in the configured endpoint, or leave blank to always execute.
$options['format'] = '%h %l %u %t \"%r\" %>s %b'; // string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
$options['format_version'] = self::FORMAT_VERSION_v2; // 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`.
$options['tls_ca_cert'] = 'null'; // string | A secure certificate to authenticate a server with. Must be in PEM format.
$options['tls_client_cert'] = 'null'; // string | The client certificate used to make authenticated requests. Must be in PEM format.
$options['tls_client_key'] = 'null'; // string | The client private key used to make authenticated requests. Must be in PEM format.
$options['tls_hostname'] = 'null'; // string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported.
$options['topic'] = 'topic_example'; // string | The Kafka topic to send logs to. Required.
$options['brokers'] = 'brokers_example'; // string | A comma-separated list of IP addresses or hostnames of Kafka brokers. Required.
$options['compression_codec'] = 'compression_codec_example'; // string | The codec used for compression of your logs.
$options['required_acks'] = 1; // int | The number of acknowledgements a leader must receive before a write is considered successful.
$options['request_max_bytes'] = 0; // int | The maximum number of bytes sent in one request. Defaults `0` (no limit).
$options['parse_log_keyvals'] = True; // bool | Enables parsing of key=value tuples from the beginning of a logline, turning them into [record headers](https://cwiki.apache.org/confluence/display/KAFKA/KIP-82+-+Add+Record+Headers).
$options['auth_method'] = 'auth_method_example'; // string | SASL authentication method.
$options['user'] = 'user_example'; // string | SASL user.
$options['password'] = 'password_example'; // string | SASL password.
$options['use_tls'] = new \Fastly\Model\LoggingUseTls(); // \Fastly\Model\LoggingUseTls

try {
    $result = $apiInstance->createLogKafka($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingKafkaApi->createLogKafka: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
service_id string Alphanumeric string identifying the service.
version_id int 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] [one of: 'none', 'waf_debug', 'null']
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. [optional] [defaults to '%h %l %u %t "%r" %>s %b']
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] [one of: 1, 2]
tls_ca_cert string A secure certificate to authenticate a server with. Must be in PEM format. [optional] [defaults to 'null']
tls_client_cert string The client certificate used to make authenticated requests. Must be in PEM format. [optional] [defaults to 'null']
tls_client_key string The client private key used to make authenticated requests. Must be in PEM format. [optional] [defaults to 'null']
tls_hostname string The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. [optional] [defaults to 'null']
topic string The Kafka topic to send logs to. Required. [optional]
brokers string A comma-separated list of IP addresses or hostnames of Kafka brokers. Required. [optional]
compression_codec string The codec used for compression of your logs. [optional] [one of: 'gzip', 'snappy', 'lz4', 'null']
required_acks int The number of acknowledgements a leader must receive before a write is considered successful. [optional] [one of: 1, 0, -1]
request_max_bytes int The maximum number of bytes sent in one request. Defaults 0 (no limit). [optional] [defaults to 0]
parse_log_keyvals bool Enables parsing of key=value tuples from the beginning of a logline, turning them into record headers. [optional]
auth_method string SASL authentication method. [optional] [one of: 'plain', 'scram-sha-256', 'scram-sha-512']
user string SASL user. [optional]
password string SASL password. [optional]
use_tls \Fastly\Model\LoggingUseTls [optional]

Return type

\Fastly\Model\LoggingKafkaResponsePost

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

deleteLogKafka()

deleteLogKafka($options): \Fastly\Model\InlineResponse200 // Delete the Kafka log endpoint

Delete the Kafka logging endpoint for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['logging_kafka_name'] = 'logging_kafka_name_example'; // string | The name for the real-time logging configuration.

try {
    $result = $apiInstance->deleteLogKafka($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingKafkaApi->deleteLogKafka: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

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

Return type

\Fastly\Model\InlineResponse200

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

getLogKafka()

getLogKafka($options): \Fastly\Model\LoggingKafkaResponse // Get a Kafka log endpoint

Get the Kafka logging endpoint for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['logging_kafka_name'] = 'logging_kafka_name_example'; // string | The name for the real-time logging configuration.

try {
    $result = $apiInstance->getLogKafka($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingKafkaApi->getLogKafka: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

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

Return type

\Fastly\Model\LoggingKafkaResponse

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

listLogKafka()

listLogKafka($options): \Fastly\Model\LoggingKafkaResponse[] // List Kafka log endpoints

List all of the Kafka logging endpoints for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.

try {
    $result = $apiInstance->listLogKafka($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingKafkaApi->listLogKafka: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

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

Return type

\Fastly\Model\LoggingKafkaResponse[]

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

updateLogKafka()

updateLogKafka($options): \Fastly\Model\LoggingKafkaResponse // Update the Kafka log endpoint

Update the Kafka logging endpoint for a particular service and version.

Example

    $options['service_id'] = 'service_id_example'; // string | Alphanumeric string identifying the service.
$options['version_id'] = 56; // int | Integer identifying a service version.
$options['logging_kafka_name'] = 'logging_kafka_name_example'; // string | The name for the real-time logging configuration.

try {
    $result = $apiInstance->updateLogKafka($options);
} catch (Exception $e) {
    echo 'Exception when calling LoggingKafkaApi->updateLogKafka: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

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

Return type

\Fastly\Model\LoggingKafkaResponse

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