Skip to content

Instantly share code, notes, and snippets.

@shirou
Last active June 3, 2020 13:06
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save shirou/5241facec4ae8ecddb02e454362d4dfe to your computer and use it in GitHub Desktop.
Save shirou/5241facec4ae8ecddb02e454362d4dfe to your computer and use it in GitHub Desktop.
opentelemtry翻訳一時的置き場

辞書

  • document
    • 文章
  • context
    • コンテキスト
  • context propagation
    • コンテキスト伝搬
  • Metrics
    • メトリック
  • CorrelationContext
    • ??? とりあえずCorrelationContext
  • Tracer
    • ??? とりあえずTracer
  • Span
    • ??? とりあえずSpan
  • mutable
    • 改変可能
  • Option
    • 省略可能
  • record
    • 記録する
  • stat
    • ??
  • trace
    • トレース??
  • cluster
    • クラスター (クラスタではない)

OpenTelemetry プロジェクトのパッケージレイアウト

この文章ではOpenTelemetryプロジェクトの基本的な"look and feel(見た目)"のレイアウトについて説明します。このパッケージレイアウトは意図的に一般化して言語に依存しない構造にしています。

API パッケージ

OpenTelemetryのAPIパッケージ関する一般的な構造を示します。

典型的なトップレベルのディレクトリ構造は以下のとおりです:

api
   ├── context
   │   └── propagation
   ├── metrics
   ├── trace
   │   └── propagation
   ├── correlationcontext
   │   └── propagation
   ├── internal
   └── logs

小文字で、CamelCaseかsnake_caseを使います。どちらを使うかは言語によって異なります。

/context

このディレクトリにはプロセス内のコンテキスト伝搬に関するAPIを提供します。

このディレクトリにはアプリケーションのメトリックを保存するためのメトリック APIを提供します。

このAPIは2つのメインクラスを提供します。

  • Tracer はすべての操作で使われます。 Tracer セクションを参照してください。
  • Span は現在の操作・実行についての情報を保持する改変可能なオブジェクトです。 Span セクションを参照してください。

/internal (省略可能)

このディレクトリはアプリケーションとライブラリのコードを提供します。

/logs (将来実装)

TODO: ログ操作

SDK パッケージ

OpenTelemtry SDKパッケージの一般的なパッケージ構造について説明します。

典型的なトップレベルのディレクトリ構造は以下のとおりです:

sdk
   ├── context
   ├── metrics
   ├── resource
   ├── trace
   ├── correlationcontext
   ├── internal
   └── logs

小文字で、CamelCaseかsnake_caseを使います。どちらを使うかは言語によって異なります。

/sdk/context

このディレクトリは api/context のSDK実装を提供します。

/sdk/metrics

このディレクトリは api/metrics のSDK実装を提供します。

このリソースディレクトリはあるエンティティについて状態あるいはトレースの情報を取得するかを示す Resource 型を定義します。 例えばKubernetesクラスターで提供されているmetricはそのクラスター、namespace、pod、あるいはコンテナ名などで使われているリソースと関連があります。

/sdk/correlationcontext

このディレクトリは api/trace のSDK実装を提供します。

/sdk/internal (省略可)

非公開のアプリケーションあるいはライブラリのコードです。

/sdk/logs (将来実装)

TODO: ログ操作

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment