APIs.io Engineering Platform · Schema

logpush_output_options

The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
CVE-2021-4428	boolean	If set to true, will cause all occurrences of `${` in the generated files to be replaced with `x{`.
batch_prefix	string	String to be prepended before each batch.
batch_suffix	string	String to be appended after each batch.
field_delimiter	string	String to join fields. This field be ignored when `record_template` is set.
field_names	array	List of field names to be included in the Logpush output. For the moment, there is no option to add all fields at once, so you must specify all the fields names you are interested in.
output_type	string	Specifies the output type, such as `ndjson` or `csv`. This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are differ
record_delimiter	string	String to be inserted in-between the records as separator.
record_prefix	string	String to be prepended before each record.
record_suffix	string	String to be appended after each record.
record_template	string	String to use as template for each record instead of the default comma-separated list. All fields used in the template must be present in `field_names` as well, otherwise they will end up as null. For
sample_rate	number	Floating number to specify sampling rate. Sampling is applied on top of filtering, and regardless of the current `sample_interval` of the data.
timestamp_format	string	String to specify the format for timestamps, such as `unixnano`, `unix`, or `rfc3339`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/logpush_output_options",
  "title": "logpush_output_options",
  "description": "The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.",
  "nullable": true,
  "properties": {
    "CVE-2021-4428": {
      "default": false,
      "description": "If set to true, will cause all occurrences of `${` in the generated files to be replaced with `x{`.",
      "nullable": true,
      "type": "boolean"
    },
    "batch_prefix": {
      "default": "",
      "description": "String to be prepended before each batch.",
      "nullable": true,
      "type": "string"
    },
    "batch_suffix": {
      "default": "",
      "description": "String to be appended after each batch.",
      "nullable": true,
      "type": "string"
    },
    "field_delimiter": {
      "default": ",",
      "description": "String to join fields. This field be ignored when `record_template` is set.",
      "nullable": true,
      "type": "string"
    },
    "field_names": {
      "description": "List of field names to be included in the Logpush output. For the moment, there is no option to add all fields at once, so you must specify all the fields names you are interested in.",
      "example": [
        "ClientIP",
        "EdgeStartTimestamp",
        "RayID"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "output_type": {
      "default": "ndjson",
      "description": "Specifies the output type, such as `ndjson` or `csv`. This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are different between output types.",
      "enum": [
        "ndjson",
        "csv"
      ],
      "example": "ndjson",
      "type": "string"
    },
    "record_delimiter": {
      "default": "",
      "description": "String to be inserted in-between the records as separator.",
      "nullable": true,
      "type": "string"
    },
    "record_prefix": {
      "default": "{",
      "description": "String to be prepended before each record.",
      "nullable": true,
      "type": "string"
    },
    "record_suffix": {
      "default": "}\n",
      "description": "String to be appended after each record.",
      "nullable": true,
      "type": "string"
    },
    "record_template": {
      "default": "",
      "description": "String to use as template for each record instead of the default comma-separated list. All fields used in the template must be present in `field_names` as well, otherwise they will end up as null. Format as a Go `text/template` without any standard functions, like conditionals, loops, sub-templates, etc.",
      "nullable": true,
      "type": "string"
    },
    "sample_rate": {
      "default": 1,
      "description": "Floating number to specify sampling rate. Sampling is applied on top of filtering, and regardless of the current `sample_interval` of the data.",
      "format": "float",
      "maximum": 1,
      "minimum": 0,
      "nullable": true,
      "type": "number"
    },
    "timestamp_format": {
      "default": "unixnano",
      "description": "String to specify the format for timestamps, such as `unixnano`, `unix`, or `rfc3339`.",
      "enum": [
        "unixnano",
        "unix",
        "rfc3339"
      ],
      "type": "string"
    }
  },
  "type": "object"
}