Skip to content

Pavel.kim/k9 add decoder processor to public api #30480

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-07-17 19:55:30.565121",
"spec_repo_commit": "f2ae7ebd"
"regenerated": "2025-07-17 21:14:22.458813",
"spec_repo_commit": "98aea434"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-07-17 19:55:39.911871",
"spec_repo_commit": "f2ae7ebd"
"regenerated": "2025-07-17 21:14:31.554366",
"spec_repo_commit": "98aea434"
}
}
}
12 changes: 6 additions & 6 deletions content/en/api/v1/logs-pipelines/examples.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"filter": {
"query": "source:python"
},
"name": "testDecoderProcessor",
"processors": [
{
"type": "decoder-processor",
"is_enabled": true,
"name": "test_decoder",
"source": "encoded_message",
"target": "decoded_message",
"binary_to_text_encoding": "base16",
"input_representation": "utf_8"
}
],
"tags": []
}
5 changes: 5 additions & 0 deletions data/api/v1/CodeExamples.json
Original file line number Diff line number Diff line change
Expand Up @@ -638,6 +638,11 @@
"suffix": "_1267211320",
"description": "Create a pipeline with Array Processor Select Operation returns \"OK\" response"
},
{
"group": "logs_pipelines",
"suffix": "_3336967838",
"description": "Create a pipeline with Decoder Processor returns \"OK\" response"
},
{
"group": "logs_pipelines",
"suffix": "_2707101123",
Expand Down
67 changes: 67 additions & 0 deletions data/api/v1/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5654,6 +5654,72 @@ components:
type: string
x-enum-varnames:
- DATE_REMAPPER
LogsDecoderProcessor:
description: 'The decoder processor decodes any source attribute containing
a

base64/base16-encoded UTF-8/ASCII string back to its original value, storing
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
base64/base16-encoded UTF-8/ASCII string to back to its original value, storing
base64/base16-encoded UTF-8/ASCII string back to its original value, storing

It seems an additional to was accidentally added

the

result in a target attribute.'
properties:
binary_to_text_encoding:
$ref: '#/components/schemas/LogsDecoderProcessorBinaryToTextEncoding'
input_representation:
$ref: '#/components/schemas/LogsDecoderProcessorInputRepresentation'
is_enabled:
default: false
description: Whether the processor is enabled.
type: boolean
name:
description: Name of the processor.
type: string
source:
description: Name of the log attribute with the encoded data.
example: encoded_message
type: string
target:
description: Name of the log attribute that contains the decoded data.
example: decoded_message
type: string
type:
$ref: '#/components/schemas/LogsDecoderProcessorType'
required:
- source
- target
- binary_to_text_encoding
- input_representation
- type
type: object
LogsDecoderProcessorBinaryToTextEncoding:
description: The encoding used to represent the binary data.
enum:
- base64
- base16
example: base64
type: string
x-enum-varnames:
- BASE64
- BASE16
LogsDecoderProcessorInputRepresentation:
description: The original representation of input string.
enum:
- utf_8
- integer
example: utf_8
type: string
x-enum-varnames:
- UTF_8
- INTEGER
LogsDecoderProcessorType:
default: decoder-processor
description: Type of logs decoder processor.
enum:
- decoder-processor
example: decoder-processor
type: string
x-enum-varnames:
- DECODER_PROCESSOR
LogsExclusion:
description: Represents the index exclusion filter object from configuration
API.
Expand Down Expand Up @@ -6322,6 +6388,7 @@ components:
- $ref: '#/components/schemas/LogsTraceRemapper'
- $ref: '#/components/schemas/LogsSpanRemapper'
- $ref: '#/components/schemas/LogsArrayProcessor'
- $ref: '#/components/schemas/LogsDecoderProcessor'
LogsQueryCompute:
description: Define computation for a log query.
properties:
Expand Down
Loading
Loading