Skip to main content

Parameters

See plugin common configurations for configuration options available to all plugins.

  • endpoint

    object[object]


    required


    Splunk HEC endpoint configurations.

    • url

      string


      required


      Splunk HEC event collector API endpoint.

    • token

      string


      required


      Splunk HEC authentication token.

    • channel

      string


      Splunk HEC send data channel identifier. For more information, see About HTTP Event Collector Indexer Acknowledgment.

    • timeout

      integer


      default: 10


      Splunk HEC send data timeout in seconds.

    • keepalive_timeout

      integer


      default: 60000


      vaild vaule:

      greater than or equal to 1000


      Keepalive timeout in milliseconds.

  • ssl_verify

    boolean


    default: true


  • log_format

    object


    Custom log format in key-value pairs in JSON format. Support built-in variables in values.

    You can also configure log format on a global scale using the plugin metadata, which configures the log format for all http-logger plugin instances. If the log format configured on the individual plugin instance differs from the log format configured on plugin metadata, the log format configured on the individual plugin instance takes precedence. See the example for more details.

  • name

    string


    default: splunk-hec-logging


    Unique identifier of the plugin for the batch processor.

  • batch_max_size

    integer


    default: 1000


    vaild vaule:

    greater than 0


    The number of log entries allowed in one batch. Once reached, the batch will be sent to Datadog agent. Setting this parameter to 1 means immediate processing.

  • inactive_timeout

    integer


    default: 5


    vaild vaule:

    greater than 0


    The maximum time in seconds to wait for new logs before sending the batch to the logging service. The value should be smaller than buffer_duration.

  • buffer_duration

    integer


    default: 60


    vaild vaule:

    greater than 0


    The maximum time in seconds from the earliest entry allowed before sending the batch to the logging service.

  • retry_delay

    integer


    default: 1


    vaild vaule:

    greater or equal to 0


    The time interval in seconds to retry sending the batch to the logging service if the batch was not successfully sent.

  • max_retry_count

    integer


    default: 60


    vaild vaule:

    greater or equal to 0


    The maximum number of unsuccessful retries allowed before dropping the log entries.


API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN PTE. LTD 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation