Skip to content

docs: clarify default maxes for distinct cache#26281

Merged
peterbarnett03 merged 1 commit intomainfrom
pbarnett/default-maxes-for-distinct-cache
Apr 16, 2025
Merged

docs: clarify default maxes for distinct cache#26281
peterbarnett03 merged 1 commit intomainfrom
pbarnett/default-maxes-for-distinct-cache

Conversation

@peterbarnett03
Copy link
Copy Markdown
Contributor

Tiny PR. Clarifies that the default max age for a Distinct Cache is 1d (86000 seconds) and default max cardinality is 100000.

Will have to move this into the new CLI help eventually.

No ticket. Based on user feedback.

@hiltontj hiltontj changed the title update: clarify default maxes for distinct cache feat: update default maxes for distinct cache Apr 16, 2025
@peterbarnett03 peterbarnett03 force-pushed the pbarnett/default-maxes-for-distinct-cache branch from 9c2debf to ff0f97b Compare April 16, 2025 19:25
@hiltontj hiltontj changed the title feat: update default maxes for distinct cache feat: clarify default maxes for distinct cache Apr 16, 2025
@hiltontj hiltontj changed the title feat: clarify default maxes for distinct cache docs: clarify default maxes for distinct cache Apr 16, 2025

/// The maximum age of an entry in the cache entered as a human-readable duration, e.g., "30d", "24h"
#[clap(long = "max-age")]
#[clap(long = "max-age", default_value = "1d")]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default should already have been 1 day:

const DEFAULT_MAX_AGE: Duration = Duration::from_secs(24 * 60 * 60);

I guess this is just for the purpose of documentation? Since, the coded default doesn't appear in the CLI output anywhere.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, had a user running into issues because it makes it 1d if you don't specify and they were loading in historical data, so they didn't know why they weren't seeing the data. Something we should probably make more clear or revisit in general, but a small update for now.

@peterbarnett03 peterbarnett03 merged commit 2ceed95 into main Apr 16, 2025
8 of 14 checks passed
@peterbarnett03 peterbarnett03 deleted the pbarnett/default-maxes-for-distinct-cache branch April 16, 2025 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants