Skip to content

Commit 8dbce72

Browse files
authored
Docs: Documentation for Prebid Cache traceability improvements (prebid#3774)
1 parent 474ad5c commit 8dbce72

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

docs/config-app.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,7 @@ For `JVM` metrics
285285
- `cache.path` - set the external Cache Service path, for example `/cache`.
286286
- `storage.pbc.enabled` - If set to true, this will allow storing modules’ data in third-party storage.
287287
- `storage.pbc.path` - set the external Cache Service path for module caching, for example `/pbc-storage`.
288+
- `cache.api-key-secured` - if set to `true`, will cause Prebid Server to add a special API key header to Prebid Cache requests.
288289
- `pbc.api.key` - set the external Cache Service api key for secured calls.
289290
- `cache.query` - appends to the cache path as query string params (used for legacy Auction requests).
290291
- `cache.banner-ttl-seconds` - how long (in seconds) banner will be available via the external Cache Service.
@@ -294,6 +295,7 @@ for particular publisher account. Overrides `cache.banner-ttl-seconds` property.
294295
- `cache.account.<ACCOUNT>.video-ttl-seconds` - how long (in seconds) video creative will be available in Cache Service
295296
for particular publisher account. Overrides `cache.video-ttl-seconds` property.
296297
- `cache.default-ttl-seconds.{banner, video, audio, native}` - a default value how long (in seconds) a creative of the specific type will be available in Cache Service
298+
- `cache.append-trace-info-to-cache-id` - if set to `true`, causes the addition account ID and datacenter to cache UUID: _ACCOUNT-DATACENTER-remainderOfUUID_. Implies that cache UUID will be generated by the Prebid Server.
297299

298300
## Application settings (account configuration, stored ad unit configurations, stored requests)
299301
Preconfigured application settings can be obtained from multiple data sources consequently:

docs/metrics.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,13 @@ Following metrics are collected and submitted if account is configured with `det
104104
- `prebid_cache.requests.ok` - timer tracking how long did successful cache requests take
105105
- `prebid_cache.requests.err` - timer tracking how long did failed cache requests take
106106
- `prebid_cache.creative_size.<creative_type>` - histogram tracking creative sizes for specific type
107+
- `prebid_cache.creative_ttl.<creative_type>` - histogram tracking creative TTL for specific type
107108

108109
## Prebid Cache per-account metrics
109110
- `account.<account-id>.prebid_cache.requests.ok` - timer tracking how long did successful cache requests take when incoming request was from `<account-id>`
110111
- `account.<account-id>.prebid_cache.requests.err` - timer tracking how long did failed cache requests take when incoming request was from `<account-id>`
111112
- `account.<account-id>.prebid_cache.creative_size.<creative_type>` - histogram tracking creative sizes for specific type when incoming request was from `<account-id>`
113+
- `account.<account-id>.prebid_cache.creative_ttl.<creative_type>` - histogram tracking creative TTL for specific type when incoming request was from `<account-id>`
112114

113115
## /cookie_sync endpoint metrics
114116
- `cookie_sync_requests` - number of requests received

0 commit comments

Comments
 (0)