Skip to content

Docs: documentation for Prebid Cache traceability improvements #3774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Net-burst merged 1 commit into from
Feb 25, 2025
Merged

Docs: documentation for Prebid Cache traceability improvements #3774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/config-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,7 @@ For `JVM` metrics
- `cache.path` - set the external Cache Service path, for example `/cache`.
- `storage.pbc.enabled` - If set to true, this will allow storing modules’ data in third-party storage.
- `storage.pbc.path` - set the external Cache Service path for module caching, for example `/pbc-storage`.
- `cache.api-key-secured` - if set to `true`, will cause Prebid Server to add a special API key header to Prebid Cache requests.
- `pbc.api.key` - set the external Cache Service api key for secured calls.
- `cache.query` - appends to the cache path as query string params (used for legacy Auction requests).
- `cache.banner-ttl-seconds` - how long (in seconds) banner will be available via the external Cache Service.
Expand All @@ -294,6 +295,7 @@ for particular publisher account. Overrides `cache.banner-ttl-seconds` property.
- `cache.account.<ACCOUNT>.video-ttl-seconds` - how long (in seconds) video creative will be available in Cache Service
for particular publisher account. Overrides `cache.video-ttl-seconds` property.
- `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
- `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.

## Application settings (account configuration, stored ad unit configurations, stored requests)
Preconfigured application settings can be obtained from multiple data sources consequently:
Expand Down
2 changes: 2 additions & 0 deletions docs/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,13 @@ Following metrics are collected and submitted if account is configured with `det
- `prebid_cache.requests.ok` - timer tracking how long did successful cache requests take
- `prebid_cache.requests.err` - timer tracking how long did failed cache requests take
- `prebid_cache.creative_size.<creative_type>` - histogram tracking creative sizes for specific type
- `prebid_cache.creative_ttl.<creative_type>` - histogram tracking creative TTL for specific type

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

## /cookie_sync endpoint metrics
- `cookie_sync_requests` - number of requests received
Expand Down
Loading