Skip to content

Commit

Permalink
update README & add chlog
Browse files Browse the repository at this point in the history
  • Loading branch information
HubertFraczek authored and Hubert Fraczek committed Feb 11, 2025
1 parent 6d8cc31 commit 6bda059
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
27 changes: 27 additions & 0 deletions .chloggen/redis-prefix.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: 'enhancement'

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: redisstorageextension

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: allow redis key prefix to be specified in extension config

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [37677]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [user]
2 changes: 1 addition & 1 deletion extension/storage/redisstorageextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The extension requires read and write access to a Redis cluster.
- `password` (optional): The password to connect to the redis instance. Default: ``
- `db` (optional): Database to be selected after connecting to the server. Default: 0
- `expiration` (optional): TTL for all storage entries. Default TTL means the key has no expiration time. Default: 0
- `prefix` (optional): Prefix to be used for a redis key. Default:`<component_kind>_<component_type>_<component_name>_<storage_extension_name>` - e.g. `receiver_filelog_` if filelog receiver & redisstorage extension have no names
- `prefix` (optional): The prefix used for the redis key. If specified, it will be appended to the default as follows: `_<prefix>`. Default: `<component_kind>_<component_type>_<component_name>_<storage_extension_name>`.

## Example

Expand Down

0 comments on commit 6bda059

Please sign in to comment.