string

string

string

Prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_MONGO_META for Mongo Pump TYK_PMP_PUMPS_UPTIME_META for Uptime Pump TYK_PMP_PUMPS_MONGOAGGREGATE_META for Mongo Aggregate Pump TYK_PMP_PUMPS_MONGOSELECTIVE_META for Mongo Selective Pump TYK_PMP_PUMPS_MONGOGRAPH_META for Mongo Graph Pump.

string

The full URL to your MongoDB instance, this can be a clustered instance if necessary and should include the database and username / password data.

bool

Set to true to enable Mongo SSL connection.

bool

Allows the use of self-signed certificates when connecting to an encrypted MongoDB database.

bool

Ignore hostname check when it differs from the original (for example with SSH tunneling). The rest of the TLS verification will still be performed.

string

Path to the PEM file with trusted root certificates

string

Path to the PEM file which contains both client certificate and private key. This is required for Mutual TLS.

MongoType

Specifies the mongo DB Type. If it's 0, it means that you are using standard mongo db. If it's 1 it means you are using AWS Document DB. If it's 2, it means you are using CosmosDB. Defaults to Standard mongo (0).

bool

Set to true to disable the default tyk index creation.

string

Set the consistency mode for the session, it defaults to Strong. The valid values are: strong, monotonic, eventual.

string

MongoDriverType is the type of the driver (library) to use. The valid values are: “mongo-go” and “mgo”. Since v1.9, the default driver is "mongo-go". Check out this guide to learn about MongoDB drivers supported by Tyk Pump.

bool

MongoDirectConnection informs whether to establish connections only with the specified seed servers, or to obtain information for the whole cluster and establish connections with further servers too. If true, the client will only connect to the host provided in the ConnectionString and won't attempt to discover other hosts in the cluster. Useful when network restrictions prevent discovery, such as with SSH tunneling. Default is false.

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_CSV_META

string

The directory and the filename where the CSV data will be stored.

*CSVConf

bool

CommonPumpConfig

analytics.AnalyticsFilters

int

int

bool

*logrus.Entry

[]string

bool

bool

[]PrometheusMetric

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_DOGSTATSD_META

string

Prefix for your metrics to datadog.

string

Address of the datadog agent including host & port.

float64

Defaults to 1 which equates to 100% of requests. To sample at 50%, set to 0.5.

bool

Enable async UDS over UDP https://github.com/Datadog/datadog-go#unix-domain-sockets-client.

int

Integer write timeout in seconds if async_uds: true.

bool

Enable buffering of messages.

int

Max messages in single datagram if buffered: true. Default 16.

[]string

List of tags to be added to the metric. The possible options are listed in the below example.

If no tag is specified the fallback behavior is to use the below tags:

• path
• method
• response_code
• api_version
• api_name
• api_id
• org_id
• tracked
• oauth_id

Note that this configuration can generate significant charges due to the unbound nature of the path tag.

"dogstatsd": {
  "type": "dogstatsd",
  "meta": {
    "address": "localhost:8125",
    "namespace": "pump",
    "async_uds": true,
    "async_uds_write_timeout_seconds": 2,
    "buffered": true,
    "buffered_max_messages": 32,
    "sample_rate": 0.5,
    "tags": [
      "method",
      "response_code",
      "api_version",
      "api_name",
      "api_id",
      "org_id",
      "tracked",
      "path",
      "oauth_id"
    ]
  }
},

On startup, you should see the loaded configs when initializing the dogstatsd pump

[May 10 15:23:44]  INFO dogstatsd: initializing pump
[May 10 15:23:44]  INFO dogstatsd: namespace: pump.
[May 10 15:23:44]  INFO dogstatsd: sample_rate: 50%
[May 10 15:23:44]  INFO dogstatsd: buffered: true, max_messages: 32
[May 10 15:23:44]  INFO dogstatsd: async_uds: true, write_timeout: 2s

*DogStatsdConf

*statsd.Client

CommonPumpConfig

CommonPumpConfig

*elasticv3.Client

*elasticv3.BulkProcessor

*logrus.Entry

*elasticv5.Client

*elasticv5.BulkProcessor

*logrus.Entry

*elasticv6.Client

*elasticv6.BulkProcessor

*logrus.Entry

*elasticv7.Client

*elasticv7.BulkProcessor

*logrus.Entry

int

Number of workers. Defaults to 1.

int

Specifies the time in seconds to flush the data and send it to ES. Default disabled.

int

Specifies the number of requests needed to flush the data and send it to ES. Defaults to 1000 requests. If it is needed, can be disabled with -1.

int

Specifies the size (in bytes) needed to flush the data and send it to ES. Defaults to 5MB. If it is needed, can be disabled with -1.

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_ELASTICSEARCH_META

string

The name of the index that all the analytics data will be placed in. Defaults to "tyk_analytics".

string

If sniffing is disabled, the URL that all data will be sent to. Defaults to "http://localhost:9200".

bool

If sniffing is enabled, the "elasticsearch_url" will be used to make a request to get a list of all the nodes in the cluster, the returned addresses will then be used. Defaults to false.

string

The type of the document that is created in ES. Defaults to "tyk_analytics".

bool

Appends the date to the end of the index name, so each days data is split into a different index name. E.g. tyk_analytics-2016.02.28. Defaults to false.

bool

If set to true will include the following additional fields: Raw Request, Raw Response and User Agent.

bool

When enabled, generate _id for outgoing records. This prevents duplicate records when retrying ES.

bool

Allows for the base64 bits to be decode before being passed to ES.

string

Specifies the ES version. Use "3" for ES 3.X, "5" for ES 5.X, "6" for ES 6.X, "7" for ES 7.X . Defaults to "3".

bool

Disable batch writing. Defaults to false.

ElasticsearchBulkConfig

Batch writing trigger configuration. Each option is an OR with eachother:

string

API Key ID used for APIKey auth in ES. It's send to ES in the Authorization header as ApiKey base64(auth_api_key_id:auth_api_key)

string

API Key used for APIKey auth in ES. It's send to ES in the Authorization header as ApiKey base64(auth_api_key_id:auth_api_key)

string

Basic auth username. It's send to ES in the Authorization header as username:password encoded in base64.

string

Basic auth password. It's send to ES in the Authorization header as username:password encoded in base64.

bool

Enables SSL connection.

bool

Controls whether the pump client verifies the Elastic Search server's certificate chain and hostname.

string

Can be used to set custom certificate file for authentication with Elastic Search.

string

Can be used to set custom key file for authentication with Elastic Search.

any

ElasticsearchOperator

*ElasticsearchConf

CommonPumpConfig

CommonPumpConfig

MongoPump

*SQLAggregatePumpConf

*gorm.DB

CommonPumpConfig

string

TableName is a configuration field unique to the sql-graph pump, this field specifies the name of the sql table to be created/used for the pump in the cases of non-sharding in the case of sharding, it specifies the table prefix

SQLConf

*gorm.DB

*GraphSQLConf

string

CommonPumpConfig

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_GRAYLOG_META

string

Graylog host.

int

Graylog port.

[]string

List of tags to be added to the metric. The possible options are listed in the below example.

If no tag is specified the fallback behaviour is to don't send anything. The possible values are:

• path
• method
• response_code
• api_version
• api_name
• api_id
• org_id
• tracked
• oauth_id
• raw_request
• raw_response
• request_time
• ip_address

*gelf.Gelf

*GraylogConf

CommonPumpConfig

CommonPumpConfig

*gorpc.Client

*gorpc.Dispatcher

atomic.Value

*gorpc.DispatcherClient

*HybridPumpConf

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_HYBRID_META

string

MDCB URL connection string

string

Your organization ID to connect to the MDCB installation.

string

This the API key of a user used to authenticate and authorize the Hybrid Pump access through MDCB. The user should be a standard Dashboard user with minimal privileges so as to reduce any risk if the user is compromised.

[]string

Specifies prefixes of tags that should be ignored if aggregated is set to true.

int

Hybrid pump RPC calls timeout in seconds. Defaults to 10 seconds.

int

Hybrid pump connection pool size. Defaults to 5.

int

aggregationTime is to specify the frequency of the aggregation in minutes if aggregated is set to true.

bool

Send aggregated analytics data to Tyk MDCB

bool

Specifies if it should store aggregated data for all the endpoints if aggregated is set to true. By default, false which means that only store aggregated data for tracked endpoints.

bool

Determines if the aggregations should be made per minute (true) or per hour (false) if aggregated is set to true.

bool

Use SSL to connect to Tyk MDCB

bool

Skip SSL verification

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_INFLUX2_META

string

InfluxDB2 pump bucket name.

string

InfluxDB2 pump organization name.

string

InfluxDB2 pump host.

string

InfluxDB2 pump database token.

[]string

Define which Analytics fields should be sent to InfluxDB2. Check the available fields in the example below. Default value is ["method", "path", "response_code", "api_key", "time_stamp", "api_version", "api_name", "api_id", "org_id", "oauth_id", "raw_request", "request_time", "raw_response", "ip_address"].

[]string

List of tags to be added to the metric.

bool

Flush data to InfluxDB2 as soon as the pump receives it

bool

Create the bucket if it doesn't exist

NewBucket

New bucket configuration

*Influx2Conf

influxdb2.Client

CommonPumpConfig

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_INFLUX_META

string

InfluxDB pump database name.

string

InfluxDB pump host.

string

InfluxDB pump database username.

string

InfluxDB pump database password.

[]string

Define which Analytics fields should be sent to InfluxDB. Check the available fields in the example below. Default value is ["method", "path", "response_code", "api_key", "time_stamp", "api_version", "api_name", "api_id", "org_id", "oauth_id", "raw_request", "request_time", "raw_response", "ip_address"].

[]string

List of tags to be added to the metric.

*InfluxConf

CommonPumpConfig

map[string]any

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_KAFKA_META

[]string

The list of brokers used to discover the partitions available on the kafka cluster. E.g. "localhost:9092".

string

Unique identifier for client connections established with Kafka.

string

The topic that the writer will produce messages to.

any

Timeout is the maximum amount of seconds to wait for a connect or write to complete.

bool

Enable "github.com/golang/snappy" codec to be used to compress Kafka messages. By default is false.

map[string]string

Can be used to set custom metadata inside the kafka message.

bool

Enables SSL connection.

bool

Controls whether the pump client verifies the kafka server's certificate chain and host name.

string

Can be used to set custom certificate file for authentication with kafka.

string

Can be used to set custom key file for authentication with kafka.

string

SASL mechanism configuration. Only "plain" and "scram" are supported.

string

SASL username.

string

SASL password.

string

SASL algorithm. It's the algorithm specified for scram mechanism. It could be sha-512 or sha-256. Defaults to "sha-256".

*KafkaConf

kafka.WriterConfig

*logrus.Entry

CommonPumpConfig

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_KINESIS_META

string

A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name.

string

AWS Region the Kinesis stream targets

int

Each PutRecords (the function used in this pump)request can support up to 500 records. Each record in the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.

*kinesis.Client

*KinesisConf

*logrus.Entry

CommonPumpConfig

*lg.LogzioSender

*LogzioPumpConfig

CommonPumpConfig

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_LOGZIO_META

bool

Set the sender to check if it crosses the maximum allowed disk usage. Default value is true.

int

Set disk queue threshold, once the threshold is crossed the sender will not enqueue the received logs. Default value is 98 (percentage of disk).

string

Set drain duration (flush logs on disk). Default value is 3s.

string

The directory for the queue.

string

Token for sending data to your logzio account.

string

If you do not want to use the default Logzio url i.e. when using a proxy. Default is https://listener.logz.io:8071.

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_MOESIF_META

string

Moesif Application Id. You can find your Moesif Application Id from Moesif Dashboard -> Top Right Menu -> API Keys . Moesif recommends creating separate Application Ids for each environment such as Production, Staging, and Development to keep data isolated.

[]string

An option to mask a specific request header field.

[]string

An option to mask a specific response header field.

[]string

An option to mask a specific - request body field.

[]string

An option to mask a specific response body field.

bool

An option to disable logging of request body. Default value is false.

bool

An option to disable logging of response body. Default value is false.

string

An optional field name to identify User from a request or response header.

string

An optional field name to identify Company (Account) from a request or response header.

bool

Set this to true to enable bulk_config.

map[string]any

Batch writing trigger configuration.

• "event_queue_size" - (optional) An optional field name which specify the maximum number of events to hold in queue before sending to Moesif. In case of network issues when not able to connect/send event to Moesif, skips adding new events to the queue to prevent memory overflow. Type: int. Default value is 10000.
• "batch_size" - (optional) An optional field name which specify the maximum batch size when sending to Moesif. Type: int. Default value is 200.
• "timer_wake_up_seconds" - (optional) An optional field which specifies a time (every n seconds) how often background thread runs to send events to moesif. Type: int. Default value is 2 seconds.

string

An optional request header field name to used to identify the User in Moesif. Default value is authorization.

string

An optional field name use to parse the User from authorization header in Moesif. Default value is sub.

moesifapi.API

*MoesifConf

analytics.AnalyticsFilters

int

int

string

time.Time

map[string]any

map[string]any

map[string]any

CommonPumpConfig

BaseMongoConf

TYKCONFIGEXPAND

bool

If set to true your pump will store analytics to both your organisation defined collections z_tyk_analyticz_aggregate_{ORG ID} and your org-less tyk_analytics_aggregates collection. When set to 'false' your pump will only store analytics to your org defined collection.

bool

Specifies if it should store aggregated data for all the endpoints. By default, false which means that only store aggregated data for tracked endpoints.

[]string

Specifies prefixes of tags that should be ignored.

int

Determines the threshold of amount of tags of an aggregation. If the amount of tags is superior to the threshold, it will print an alert. Defaults to 1000.

bool

Determines if the aggregations should be made per minute (true) or per hour (false).

int

Determines the amount of time the aggregations should be made (in minutes). It defaults to the max value is 60 and the minimum is 1. If StoreAnalyticsPerMinute is set to true, this field will be skipped.

bool

Determines if the self healing will be activated or not. Self Healing allows pump to handle Mongo document's max-size errors by creating a new document when the max-size is reached. It also divide by 2 the AggregationTime field to avoid the same error in the future.

[]string

This list determines which aggregations are going to be dropped and not stored in the collection. Posible values are: "APIID","errors","versions","apikeys","oauthids","geo","tags","endpoints","keyendpoints", "oauthendpoints", and "apiendpoints".

persistent.PersistentStorage

*MongoAggregateConf

CommonPumpConfig

BaseMongoConf

TYKCONFIGEXPAND

string

Specifies the mongo collection name.

int

Maximum insert batch size for mongo selective pump. If the batch we are writing surpasses this value, it will be sent in multiple batches. Defaults to 10Mb.

int

Maximum document size. If the document exceed this value, it will be skipped. Defaults to 10Mb.

int

Amount of bytes of the capped collection in 64bits architectures. Defaults to 5GB.

bool

Enable collection capping. It's used to set a maximum size of the collection.

bool

persistent.PersistentStorage

*MongoConf

CommonPumpConfig

BaseMongoConf

TYKCONFIGEXPAND

int

Maximum insert batch size for mongo selective pump. If the batch we are writing surpass this value, it will be send in multiple batchs. Defaults to 10Mb.

int

Maximum document size. If the document exceed this value, it will be skipped. Defaults to 10Mb.

persistent.PersistentStorage

*MongoSelectiveConf

CommonPumpConfig

int

uint

Default size for string fields. Defaults to 256.

bool

Disable datetime precision, which not supported before MySQL 5.6.

bool

Drop & create when rename index, rename index not supported before MySQL 5.7, MariaDB.

bool

change when rename column, rename column not supported before MySQL 8, MariaDB.

bool

Auto configure based on currently MySQL version.

string

A description visible on the InfluxDB2 UI

[]RetentionRule

Rules to expire or retain data. No rules means data never expires.

bool

Disables implicit prepared statement usage.

string

Prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_PROMETHEUS_META

string

The full URL to your Prometheus instance, {HOST}:{PORT}. For example localhost:9090.

string

The path to the Prometheus collection. For example /metrics.

bool

This will enable an experimental feature that will aggregate the histogram metrics request time values before exposing them to prometheus. Enabling this will reduce the CPU usage of your prometheus pump but you will loose histogram precision. Experimental.

[]string

Metrics to exclude from exposition. Currently, excludes only the base metrics.

bool

Specifies if it should expose aggregated metrics for all the endpoints. By default, false which means that all APIs endpoints will be counted as 'unknown' unless the API uses the track endpoint plugin.

CustomMetrics

Custom Prometheus metrics.

string

The name of the custom metric. For example: tyk_http_status_per_api_name

string

Description text of the custom metric. For example: HTTP status codes per API

string

Determines the type of the metric. There's currently 2 available options: counter or histogram. In case of histogram, you can only modify the labels since it always going to use the request_time.

[]float64

Defines the buckets into which observations are counted. The type is float64 array and by default, [1, 2, 5, 7, 10, 15, 20, 25, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 1000, 2000, 5000, 10000, 30000, 60000]

bool

Controls whether the pump client should hide the API key. In case you still need substring of the value, check the next option. Default value is false.

int

Define the number of the characters from the end of the API key. The obfuscate_api_keys should be set to true. Default value is 4.

[]string

Defines the partitions in the metrics. For example: ['response_code','api_name']. The available labels are: ["host","method", "path", "response_code", "api_key", "time_stamp", "api_version", "api_name", "api_id", "org_id", "oauth_id","request_time", "ip_address", "alias"].

bool

*prometheus.CounterVec

*prometheus.HistogramVec

map[string]counterStruct

map[string]histogramCounter

bool

*PrometheusConf

*prometheus.CounterVec

Per service

*prometheus.CounterVec

*prometheus.CounterVec

*prometheus.CounterVec

*prometheus.HistogramVec

[]*PrometheusMetric

CommonPumpConfig

any

*logger.HttpLogger

*ResurfacePumpConfig

chan []interface{}

sync.WaitGroup

bool

CommonPumpConfig

string

string

string

[]string

int64

Duration in seconds for how long data will be kept in the database. 0 means infinite.

int64

Shard duration measured in seconds.

string

Retention rule type. For example "expire"

CommonPumpConfig

*SQLAggregatePumpConf

*gorm.DB

string

gorm.Dialector

chan bool

this channel is used to signal that the background index creation has finished - this is used for testing

SQLConf

TYKCONFIGEXPAND

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_SQLAGGREGATE_META

bool

Specifies if it should store aggregated data for all the endpoints. By default, false which means that only store aggregated data for tracked endpoints.

[]string

Specifies prefixes of tags that should be ignored.

int

bool

Determines if the aggregations should be made per minute instead of per hour.

[]string

bool

Set to true to disable the default tyk index creation.

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_SQL_META

string

The only supported and tested types are postgres and mysql. From v1.12.0, we no longer support sqlite as a storage type.

string

Specifies the connection string to the database.

PostgresConfig

Postgres configurations.

MysqlConfig

Mysql configurations.

bool

Specifies if all the analytics records are going to be stored in one table or in multiple tables (one per day). By default, false. If false, all the records are going to be stored in tyk_aggregated table. Instead, if it's true, all the records of the day are going to be stored in tyk_aggregated_YYYYMMDD table, where YYYYMMDD is going to change depending on the date.

string

Specifies the SQL log verbosity. The possible values are: info,error and warning. By default, the value is silent, which means that it won't log any SQL query.

int

Specifies the amount of records that are going to be written each batch. Type int. By default, it writes 1000 records max per batch.

CommonPumpConfig

bool

*SQLConf

*gorm.DB

string

gorm.Dialector

chan bool

this channel is used to signal that the background index creation has finished - this is used for testing

string

EnvPrefix specifies the prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_SQS_META

string

QueueName specifies the name of the AWS Simple Queue Service (SQS) queue for message delivery.

string

AWSRegion sets the AWS region where the SQS queue is located.

string

AWSSecret is the AWS secret key used for authentication.

string

AWSKey is the AWS access key ID used for authentication.

string

AWSToken is the AWS session token used for authentication. This is only required when using temporary credentials.

string

AWSEndpoint is the custom endpoint URL for AWS SQS, if applicable.

string

AWSMessageGroupID specifies the message group ID for ordered processing within the SQS queue.

bool

AWSMessageIDDeduplicationEnabled enables/disables message deduplication based on unique IDs.

int32

AWSDelaySeconds configures the delay (in seconds) before messages become available for processing.

int

AWSSQSBatchLimit sets the maximum number of messages in a single batch when sending to the SQS queue.

SQSSendMessageBatchAPI

*string

*SQSConf

*logrus.Entry

CommonPumpConfig

any

string

string

*segment.Client

*SegmentConf

CommonPumpConfig

string

string

bool

*http.Client

*retry.BackoffHTTPRetry

*SplunkClient

*SplunkPumpConfig

CommonPumpConfig

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_SPLUNK_META

string

Address of the datadog agent including host & port.

string

Endpoint the Pump will send analytics too. Should look something like: https://splunk:8088/services/collector/event.

bool

Controls whether the pump client verifies the Splunk server's certificate chain and host name.

string

SSL cert file location.

string

SSL cert key location.

string

SSL Server name used in the TLS connection.

bool

Controls whether the pump client should hide the API key. In case you still need substring of the value, check the next option. Default value is false.

int

Define the number of the characters from the end of the API key. The obfuscate_api_keys should be set to true. Default value is 0.

[]string

Define which Analytics fields should participate in the Splunk event. Check the available fields in the example below. Default value is ["method", "path", "response_code", "api_key", "time_stamp", "api_version", "api_name", "api_id", "org_id", "oauth_id", "raw_request", "request_time", "raw_response", "ip_address"].

[]string

Choose which tags to be ignored by the Splunk Pump. Keep in mind that the tag name and value are hyphenated. Default value is [].

bool

If this is set to true, pump is going to send the analytics records in batch to Splunk. Default value is false.

int

Max content length in bytes to be sent in batch requests. It should match the max_content_length configured in Splunk. If the purged analytics records size don't reach the amount of bytes, they're send anyways in each purge_loop. Default value is 838860800 (~ 800 MB), the same default value as Splunk config.

uint64

MaxRetries represents the maximum amount of retries to attempt if failed to send requests to splunk HEC. Default value is 0

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_STATSD_META

string

Address of statsd including host & port.

[]string

Define which Analytics fields should have its own metric calculation.

[]string

List of tags to be added to the metric.

bool

Allows to have a separated method field instead of having it embedded in the path field.

*StatsdConf

CommonPumpConfig

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_STDOUT_META

string

Format of the analytics logs. Default is text if json is not explicitly specified. When JSON logging is used all pump logs to stdout will be JSON.

string

Root name of the JSON object the analytics record is nested in.

CommonPumpConfig

*StdOutConf

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_SYSLOG_META

string

Possible values are udp, tcp, tls in string form.

string

Host & Port combination of your syslog daemon ie: "localhost:5140".

int

The severity level, an integer from 0-7, based off the Standard: Syslog Severity Levels.

string

Prefix tag

When working with FluentD, you should provide a FluentD Parser based on the OS you are using so that FluentD can correctly read the logs.

"syslog": {
  "name": "syslog",
  "meta": {
    "transport": "udp",
    "network_addr": "localhost:5140",
    "log_level": 6,
    "tag": "syslog-pump"
  }

*SyslogConf

*syslog.Writer

analytics.AnalyticsFilters

int

CommonPumpConfig

TimestreamWriteRecordsAPI

*TimestreamPumpConf

CommonPumpConfig

string

The prefix for the environment variables that will be used to override the configuration. Defaults to TYK_PMP_PUMPS_TIMESTREAM_META

string

The aws region that contains the timestream database

string

The table name where the data is going to be written

string

The timestream database name that contains the table being written to

[]string

A filter of all the dimensions that will be written to the table. The possible options are ["Method","Host","Path","RawPath","APIKey","APIVersion","APIName","APIID","OrgID","OauthID"]

[]string

A filter of all the measures that will be written to the table. The possible options are ["ContentLength","ResponseCode","RequestTime","NetworkStats.OpenConnections", "NetworkStats.ClosedConnection","NetworkStats.BytesIn","NetworkStats.BytesOut", "Latency.Total","Latency.Upstream","GeoData.City.GeoNameID","IPAddress", "GeoData.Location.Latitude","GeoData.Location.Longitude","UserAgent","RawRequest","RawResponse", "RateLimit.Limit","Ratelimit.Remaining","Ratelimit.Reset", "GeoData.Country.ISOCode","GeoData.City.Names","GeoData.Location.TimeZone"]

bool

Set to true in order to save any of the RateLimit measures. Default value is false.

bool

If set true, we will try to read geo information from the headers if values aren't found on the analytic record . Default value is false.

bool

Set to true, in order to save numerical values with value zero. Default value is false.

map[string]string

A name mapping for both Dimensions and Measures names. It's not required

any

any

[]string

uint64

string

uint64

uint64

[]string

map[string]any

any

persistent.PersistentStorage

model.ObjectID

string

func(ctx context.Context, params *sqs.GetQueueUrlInput, optFns ...func(*sqs.Options)) (*sqs.GetQueueUrlOutput, error)

func(ctx context.Context, params *sqs.SendMessageBatchInput, optFns ...func(*sqs.Options)) (*sqs.SendMessageBatchOutput, error)

string

string

int32

int

*testing.T

bool

int

[]splunkStatus

int

net.Listener