fastly logging kafka/create

Create a Kafka logging endpoint on a Fastly service version.

Syntax

$ fastly logging kafka/create --version=VERSION

Options

KeyRequired?DefaultDescription
--nameNoThe name of the Kafka logging object. Used as a primary key for API access
--versionYes'latest', 'active', or the number of a specific Fastly service version
--autocloneNoIf the selected service version is not editable, clone it and use the clone.
--auth-methodNoSASL authentication method. Valid values are: plain, scram-sha-256, scram-sha-512
--brokersNoA comma-separated list of IP addresses or hostnames of Kafka brokers
--compression-codecNoThe codec used for compression of your logs. One of: gzip, snappy, lz4
--formatNoApache style log formatting. Your log must produce valid JSON
--format-versionNoThe version of the custom logging format used for the configured endpoint. Can be either 2 (the default, version 2 log format) or 1 (the version 1 log format). 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
--max-batch-sizeNoThe maximum size of the log batch in bytes
--parse-log-keyvalsNoParse key-value pairs within the log format
--passwordNoSASL authentication password. Required if --auth-method is specified
--placementNoWhere in the generated VCL the logging call should be placed, overriding any format_version default. Can be none or waf_debug. This field is not required and has no default value
--required-acksNoThe Number of acknowledgements a leader must receive before a write is considered successful. One of: 1 (default) One server needs to respond. 0 No servers need to respond. -1 Wait for all in-sync replicas to respond
--response-conditionNoThe name of an existing condition in the configured endpoint, or leave blank to always execute
--service-idNoService ID (falls back to FASTLY_SERVICE_ID, then fastly.toml)
--service-nameNoThe name of the service
--tls-ca-certNoA secure certificate to authenticate the server with. Must be in PEM format
--tls-client-certNoThe client certificate used to make authenticated requests. Must be in PEM format
--tls-client-keyNoThe client private key used to make authenticated requests. Must be in PEM format
--tls-hostnameNoUsed during the TLS handshake to validate the certificate
--topicNoThe Kafka topic to send logs to
--use-saslNoEnable SASL authentication. Requires --auth-method, --username, and --password to be specified
--use-tlsNoWhether to use TLS for secure logging. Can be either true or false
--usernameNoSASL authentication username. Required if --auth-method is specified

Global options

KeyRequired?DefaultDescription
--helpNoShow context-sensitive help.
--accept-defaultsNoAccept default options for all interactive prompts apart from Yes/No confirmations
--auto-yesNoAnswer yes automatically to all Yes/No confirmations. This may suppress security warnings
--debug-modeNoPrint API request and response details (NOTE: can disrupt the normal CLI flow output formatting)
--non-interactiveNoDo not prompt for user input - suitable for CI processes. Equivalent to --accept-defaults and --auto-yes
--profileNoSwitch account profile for single command execution (see also: 'fastly profile switch')
--quietNoSilence all output except direct command output. This won't prevent interactive prompts (see: --accept-defaults, --auto-yes, --non-interactive)
--tokenNoFastly API token (or via FASTLY_API_TOKEN)
--verboseNoVerbose logging

API equivalent

This command internally uses the following Fastly public APIs: