Skip to content
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

Jump to bottom

Reorganize specification related to OTLP file exporter #3031

Merged
merged 6 commits into from
Jan 3, 2023
Merged

Reorganize specification related to OTLP file exporter #3031

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a141528
Remove built-in exporters section from Log SDK
alanwest Dec 13, 2022
aac4edd
Remove OTLP file exporter image
alanwest Dec 13, 2022
09d2650
Move experimental/serialization/json.md -> specification/protocol/fil…
alanwest Dec 13, 2022
2eb13bf
Retitle and reorganize file-exporter.md
alanwest Dec 13, 2022
6749cb2
Fix link
alanwest Dec 14, 2022
8378d67
Merge branch 'main' into alanwest/otlp-file-exporter-reorg
tigrannajaryan Jan 3, 2023
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
Binary file removed specification/logs/img/otlp-file.png
View file
Open in desktop
Binary file not shown.
21 changes: 0 additions & 21 deletions specification/logs/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,6 @@
+ [Export](#export)
+ [ForceFlush](#forceflush-2)
+ [Shutdown](#shutdown-1)
* [Built-in exporters](#built-in-exporters)
+ [OTLP Exporter](#otlp-exporter)
+ [OTLP File exporter](#otlp-file-exporter)

<!-- tocstop -->

Expand Down Expand Up @@ -365,21 +362,3 @@ return a Failure result.
`Shutdown` SHOULD NOT block indefinitely (e.g. if it attempts to flush the data
and the destination is unavailable). [OpenTelemetry SDK](../overview.md#sdk)
authors MAY decide if they want to make the shutdown timeout configurable.

### Built-in exporters

TODO: Break out into files under `./sdk_exporters`.

#### OTLP Exporter

Exports to an OTLP network destination via OTLP/gRPC or OTLP/HTTP.

#### OTLP File exporter

Writes to a file or stdout in either OTLP JSON or OTLP Protobuf binary format.

![Logging to File](img/otlp-file.png)
tigrannajaryan marked this conversation as resolved.
Show resolved Hide resolved

TODO: clarify how this functionality co-exists with the overlapping
functionality in logging libraries that allow specifying how logs are written to
a file.
20 changes: 11 additions & 9 deletions experimental/serialization/json.md → specification/protocol/file-exporter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
# JSON File serialization
# OpenTelemetry Protocol File Exporter

**Status**: [Experimental](../../specification/document-status.md)

This document provides a placeholder for specifying an OTLP exporter capable of
exporting to either a file or stdout.

Currently, it only describes the serialization of OpenTelemetry data to the OTLP JSON format.

## Table of Contents

- [Overview](#overview)
- [Requirements](#requirements)
- [JSON File serialization](#json-file-serialization)
- [File storage requirements](#file-storage-requirements)
- [JSON lines file](#json-lines-file)
- [Streaming appending](#streaming-appending)
- [Telemetry data requirements](#telemetry-data-requirements)
- [Examples](#examples)
- [Examples](#examples)

## Overview
## JSON File serialization

This document describes the serialization of OpenTelemetry data as JSON objects that can be stored in files.

## Requirements

### File storage requirements

#### JSON lines file
Expand All @@ -33,7 +35,7 @@ This file is a JSON lines file (jsonlines.org), and therefore follows those requ

There is no guarantee that the data in the file is ordered.

There is no guarantee in particular that timestamps will be monotically increasing.
There is no guarantee in particular that timestamps will be monotonically increasing.

### Telemetry data requirements

Expand All @@ -46,7 +48,7 @@ Only top-level objects, `ExportTraceServiceRequest`, `ExportMetricsServiceReques

Files must contain exactly one type of data: traces, metrics, or logs.

## Examples
### Examples

This is an example showing traces:

Expand Down