Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/caches.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Ensure that your Redis instance is located close to your Trickster instance in o

In addition to basic Redis, Trickster also supports Redis Cluster and Redis Sentinel. Refer to the sample configuration for customizing the Redis client type.

Trickster supports Redis servers that use TLS encryption by setting `use_tls: true` in the config. Refer to the sample configuration for more info.

## Purging an Item from the Cache

You can purge an item from the cache by making a call to the purge endpoint, as follows:
Expand Down
68 changes: 1 addition & 67 deletions docs/chunked_caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,12 @@ Byterange chunking splits the byterange into pieces with the same literal size.

## Full Example

This example has one Prometheus backend with a filesystem cache that has chunking *disabled*, and one InfluxDB backend with a memory cache that has chunking *enabled*. The memory cache uses 380 as its timeseries chunk factor, and doesn't define a byterange chunk size, so the default of 4096 will be used.
This example has one Prometheus backend with a memory cache that has chunking enabled. The memory cache uses 380 as its timeseries chunk factor, and doesn't define a byterange chunk size, so the default of 4096 will be used.

```yaml
frontend:
listen_port: 8480

negative_caches:
default:
'400': 3s
'404': 3s
'500': 3s
'502': 3s

caches:
mem1:
cache_type: memory
Expand All @@ -72,73 +65,14 @@ caches:
max_size_backoff_objects: 128
use_cache_chunking: true
timeseries_chunk_factor: 380
# byterange_chunk_size: 4096
fs1:
cache_type: filesystem
provider: filesystem

request_rewriters:

remove-accept-encoding:
instructions:
- [ header, delete, Accept-Encoding ]

range-to-instant:
instructions:
- [ path , set , /api/v1/query ]
- [ param , delete , start ]
- [ param , delete , end ]
- [ param , delete , step ]
- [ chain , exec , remove-accept-encoding ]

rules:
example:
input_source: header
input_key: Authorization
input_type: string
input_encoding: base64
input_index: 1
input_delimiter: ' '
operation: prefix
next_route: rpc1
cases:
'1':
matches:
- 'james:'
next_route: sim1

tracing:
jc1:
tracer_type: otlp
endpoint: 'http://127.0.0.1:14268/api/traces'
tags:
testTag: testTagValue
testTag2: testTag2Value
ja1:
tracer_type: otlp
endpoint: '127.0.0.1:6831'
omit_tags:
- http.url

backends:
prom1:
latency_max: 150ms
latency_min: 50ms
provider: prometheus
origin_url: 'http://127.0.0.1:9090'
cache_name: fs1
tls:
full_chain_cert_path: >-
/private/data/trickster/docker-compose/data/trickster-config/127.0.0.1.pem
private_key_path: >-
/private/data/trickster/docker-compose/data/trickster-config/127.0.0.1-key.pem
insecure_skip_verify: true
influx:
provider: influxdb
origin_url: 'http://127.0.0.1:8086'
cache_name: mem1
backfill_tolerance: 30s
timeseries_retention_factor: 5184000

logging:
log_level: warn
Expand Down
4 changes: 4 additions & 0 deletions docs/new-changed-2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
- The [Rules Engine](./rule.md) now supports `rmatch` operations to permit regular expression-based routing against any part of the HTTP request.
- You can now chain a collection of [request rewriters](./request_rewriters.md) for more robust possibilities.

## New in Beta 4
- The configuration format for the [Rule Backend Provider](./rule.md) has been updated to use a YAML Sequence for enumerating rules, rather than named rules via a YAML Map. See the [Full Example Configuration](../examples/conf/example.full.yaml) for more info.
- A configurable Request Body Size limit has been added for `POST`, `PUT` and `PATCH` requests, with a default of 10MB. Requests with a body size exceeding the limit will receive a `413 Content Too Large` response. See [Request Body Handling Customizations](./body.md) for more info.
- We now support TLS-based Redis Endpoints. See the [Full Example Configuration](../examples/conf/example.full.yaml) for more info.

## New in Beta 3
- We've switched to our all-new, made-for-proxies HTTP Request Router, which is up to 10X faster than the previous router
Expand Down
6 changes: 3 additions & 3 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The roadmap for Trickster in 2025 focuses on delivering Trickster versions 2.0 a
- [x] Extended support for ClickHouse
- [x] Support for InfluxDB 2.0 and Flux query syntax / payloads

### June 2025
### August 2025

- [ ] Trickster v2.0 Beta 4 Release
- [ ] Updated Grafana Dashboard for Trickster Metrics
Expand All @@ -32,12 +32,12 @@ The roadmap for Trickster in 2025 focuses on delivering Trickster versions 2.0 a
- [ ] Support for InfluxDB 3.0
- [ ] Support for Autodiscovery (e.g., Kubernetes Pod Annotations)

### July 2025
### September 2025

- [ ] Trickster v2.0 GA Release
- [ ] Overhaul Documentation for Trickster 2.0

### Late Q3/Early Q4 2025
### Q4 2025

- [ ] Trickster v2.1 Beta Release
- [ ] Kube Gateway API support
Expand Down
Loading