Caroline
ef83f6d7d5
* Added metrics section to Aggregate processor page. Signed-off-by: carolxob <[email protected]> * Added Metrics section to individual Processors pages. Signed-off-by: carolxob <[email protected]> * Added metrics section for JSON processor. Signed-off-by: carolxob <[email protected]> * Added metrics sections. Changed Default is to Default value is. Signed-off-by: carolxob <[email protected]> * Corrected references from AWS S3 to Amazon S3. Signed-off-by: carolxob <[email protected]> * Minor updates to Metrics sections and phrasing. Signed-off-by: carolxob <[email protected]> * Updated Action link. Signed-off-by: carolxob <[email protected]> * Updates based on tech review feedback. Signed-off-by: carolxob <[email protected]> * Updates based on tech review feedback. Signed-off-by: carolxob <[email protected]> * Tech review feedback. Signed-off-by: carolxob <[email protected]> * Minor updates to buffer_size and batch_size default values. Signed-off-by: carolxob <[email protected]> * Edits to Metrics sections for each processor. Signed-off-by: carolxob <[email protected]> * Update made based ondoc review feedback. Signed-off-by: carolxob <[email protected]> * Minor updates to intro text for processor pages. Minor adjustements to other text for clarity. Signed-off-by: carolxob <[email protected]> * Minor edits. Signed-off-by: carolxob <[email protected]> * Adjustements to phrasing, fixed typos. Signed-off-by: carolxob <[email protected]> * Minor updates to word choice and corrected a typo. Signed-off-by: carolxob <[email protected]> * Minor edit. Signed-off-by: carolxob <[email protected]> * Made updates based ondoc review feedback. Signed-off-by: carolxob <[email protected]> * Updates to http-source. Signed-off-by: carolxob <[email protected]> * Added common processors table to affected docs. Signed-off-by: carolxob <[email protected]> * Minor update to one file. Signed-off-by: carolxob <[email protected]> * Minor update based on tech review feedback. Signed-off-by: carolxob <[email protected]> * Minor edits. Signed-off-by: carolxob <[email protected]> * Major editorial feedback incorporated through key-value.md. Signed-off-by: carolxob <[email protected]> * Incorporated major editorial feedback thup to service-map-stateful. Signed-off-by: carolxob <[email protected]> * Incorporated major editorial feedback for Processors section. Signed-off-by: carolxob <[email protected]> * Major editorial updates, specifically to inclusion of text introducing option configuration tables. Signed-off-by: carolxob <[email protected]> * Major editorial feedback through otel-trace.md incorporated. Signed-off-by: carolxob <[email protected]> * Major editorial edits incorporated. Signed-off-by: carolxob <[email protected]> * Technical feedback and editorial feedback incorporated. Signed-off-by: carolxob <[email protected]> * Incorporated missing editorial feedback. Signed-off-by: carolxob <[email protected]> * Minor adjustements to OpenSearch sink. Signed-off-by: carolxob <[email protected]> * Minor changes to capitalization. Signed-off-by: carolxob <[email protected]> * Minor edits. Signed-off-by: carolxob <[email protected]> * Made one instance of processor name consistent with other references. Signed-off-by: carolxob <[email protected]> * Minor update based on editorial feedback. Signed-off-by: carolxob <[email protected]> --------- Signed-off-by: carolxob <[email protected]>
2.8 KiB
2.8 KiB
layout, title, parent, grand_parent, nav_order
| layout | title | parent | grand_parent | nav_order |
|---|---|---|---|---|
| default | csv | Processors | Pipelines | 45 |
csv
Overview
The csv processor parses comma-separated values (CSVs) from the event into columns. The following table describes the options you can use to configure the csv processor.
| Option | Required | Type | Description |
|---|---|---|---|
| source | No | String | The field in the event that will be parsed. Default value is message. |
| quote_character | No | String | The character used as a text qualifier for a single column of data. Default value is ". |
| delimiter | No | String | The character separating each column. Default value is ,. |
| delete_header | No | Boolean | If specified, the event header (column_names_source_key) is deleted after the event is parsed. If there is no event header, no action is taken. Default value is true. |
| column_names_source_key | No | String | The field in the event that specifies the CSV column names, which will be automatically detected. If there need to be extra column names, the column names are automatically generated according to their index. If column_names is also defined, the header in column_names_source_key can also be used to generate the event fields. If too few columns are specified in this field, the remaining column names are automatically generated. If too many column names are specified in this field, the CSV processor omits the extra column names. |
| column_names | No | List | User-specified names for the CSV columns. Default value is [column1, column2, ..., columnN] if there are no columns of data in the CSV record and column_names_source_key is not defined. If column_names_source_key is defined, the header in column_names_source_key generates the event fields. If too few columns are specified in this field, the remaining column names are automatically generated. If too many column names are specified in this field, the CSV processor omits the extra column names. |
Metrics
The following table describes common Abstract processor metrics.
| Metric name | Type | Description |
|---|---|---|
recordsIn |
Counter | Metric representing the ingress of records to a pipeline component. |
recordsOut |
Counter | Metric representing the egress of records from a pipeline component. |
timeElapsed |
Timer | Metric representing the time elapsed during execution of a pipeline component. |
The csv processor includes the following custom metrics.
Counter
csvInvalidEvents: The number of invalid events. An exception is thrown when an invalid event is parsed. An unclosed quote usually causes this exception.