CloudFoundry

ステータス: Development

CloudFoundryのメタデータを理解するのに役立つ資料:

CloudFoundryは、アプリケーションのデプロイメント（app）を、organization（org）に含まれるspaceによって整理します。名前は、それぞれを包含するentity内でのみ一意です。IDはCloudFoundryのインストール全体で一意です。同じアプリケーションの異なるインスタンスは、整数のインデックスで区別されます。アプリケーションは、メインジョブと複数のタスク、サイドカーから構成できます。それらは異なるprocess属性によって区別できます。

CloudFoundryは、システムコンポーネントからシグナルを発することもできます。これらはorgとspaceに整理されていないため、アプリケーションとは異なるアプローチを取ります。これらは、CloudFoundryのBoshデプロイメントツールに沿ったものです。

Organization

Status:

type: cloudfoundry.org

Description: 監視対象のアプリケーションのorganization。

[!warning] このEntity定義には、roleを持たない属性が含まれています。安定版のEntityは、roleが定義されていない属性を持ってはなりません（MUST NOT）。

Attributes:

Role	Key	Stability	Requirement Level	Value Type	Description	Example Values
Other	`cloudfoundry.org.id`		`Recommended`	string	そのアプリケーションが実行されているCloudFoundry orgのguid。[1]	`218fc5a9-a5f1-4b54-aa05-46717d0ab26d`
Other	`cloudfoundry.org.name`		`Recommended`	string	そのアプリケーションが実行されているCloudFoundry organizationの名前。[2]	`my-org-name`

[1] cloudfoundry.org.id: アプリケーションの計装は、環境変数VCAP_APPLICATION.org_idの値を使用すべきです。これは、cf org <org-name> --guidで報告される値と同じです。

[2] cloudfoundry.org.name: アプリケーションの計装は、環境変数VCAP_APPLICATION.org_nameの値を使用すべきです。これは、cf orgsで報告される値と同じです。

Space

Status:

type: cloudfoundry.space

Description: 監視対象のアプリケーションのspace。

[!warning] このEntity定義には、roleを持たない属性が含まれています。安定版のEntityは、roleが定義されていない属性を持ってはなりません（MUST NOT）。

Attributes:

Role	Key	Stability	Requirement Level	Value Type	Description	Example Values
Other	`cloudfoundry.space.id`		`Recommended`	string	そのアプリケーションが実行されているCloudFoundry spaceのguid。[1]	`218fc5a9-a5f1-4b54-aa05-46717d0ab26d`
Other	`cloudfoundry.space.name`		`Recommended`	string	そのアプリケーションが実行されているCloudFoundry spaceの名前。[2]	`my-space-name`

[1] cloudfoundry.space.id: アプリケーションの計装は、環境変数VCAP_APPLICATION.space_idの値を使用すべきです。これは、cf space <space-name> --guidで報告される値と同じです。

[2] cloudfoundry.space.name: アプリケーションの計装は、環境変数VCAP_APPLICATION.space_nameの値を使用すべきです。これは、cf spacesで報告される値と同じです。

Application

Status:

type: cloudfoundry.app

Description: 監視対象のアプリケーション。

[!warning] このEntity定義には、roleを持たない属性が含まれています。安定版のEntityは、roleが定義されていない属性を持ってはなりません（MUST NOT）。

Attributes:

Role	Key	Stability	Requirement Level	Value Type	Description	Example Values
Other	`cloudfoundry.app.id`		`Recommended`	string	そのアプリケーションのguid。[1]	`218fc5a9-a5f1-4b54-aa05-46717d0ab26d`
Other	`cloudfoundry.app.name`		`Recommended`	string	そのアプリケーションの名前。[2]	`my-app-name`

[1] cloudfoundry.app.id: アプリケーションの計装は、環境変数VCAP_APPLICATION.application_idの値を使用すべきです。これは、cf app <app-name> --guidで報告される値と同じです。

[2] cloudfoundry.app.name: アプリケーションの計装は、環境変数VCAP_APPLICATION.application_nameの値を使用すべきです。これは、cf appsで報告される値と同じです。

Process

Status:

type: cloudfoundry.process

Description: 監視対象のアプリケーションのプロセス。

[!warning] このEntity定義には、roleを持たない属性が含まれています。安定版のEntityは、roleが定義されていない属性を持ってはなりません（MUST NOT）。

Attributes:

Role	Key	Stability	Requirement Level	Value Type	Description	Example Values
Other	`cloudfoundry.process.id`		`Recommended`	string	そのプロセスを識別するUID。[1]	`218fc5a9-a5f1-4b54-aa05-46717d0ab26d`
Other	`cloudfoundry.process.type`		`Recommended`	string	プロセスの種別。[2]	`web`

[1] cloudfoundry.process.id: アプリケーションの計装は、環境変数VCAP_APPLICATION.process_idの値を使用すべきです。ランタイムにデプロイされたアプリケーションの場合、これはVCAP_APPLICATION.app_idと等しいはずです。システムコンポーネントの場合、これは実際のPIDである可能性があります。

[2] cloudfoundry.process.type: CloudFoundryのアプリケーションは、複数のジョブから構成できます。通常、メインプロセスはwebという種別になります。異なるプロセス種別を持つ、追加のバックグラウンドタスクやサイドカーが存在する場合もあります。

Cloud Foundry System component

Status:

type: cloudfoundry.system

Description: 監視対象のシステムコンポーネント。

[!warning] このEntity定義には、roleを持たない属性が含まれています。安定版のEntityは、roleが定義されていない属性を持ってはなりません（MUST NOT）。

Attributes:

Role	Key	Stability	Requirement Level	Value Type	Description	Example Values
Other	`cloudfoundry.system.id`		`Recommended`	string	イベントの発生源を記述する、guidまたは他の名前。[1]	`cf/gorouter`
Other	`cloudfoundry.system.instance.id`		`Recommended`	string	イベントの発生源の具体的なインスタンスを記述する、guid。[2]	`218fc5a9-a5f1-4b54-aa05-46717d0ab26d`

[1] cloudfoundry.system.id: CloudFoundryは、Loggregator v2 envelopeでsource_idを定義しています。これは、CloudFoundryが発するログとメトリクスに使われます。CloudFoundryのコンポーネントについては、コンポーネント名（例えば"gorouter"）を含むことが想定されています。

システムコンポーネントを計装する場合、Boshスペックの値を使用すべきです。system.idはspec.deployment/spec.nameに設定すべきです。

[2] cloudfoundry.system.instance.id: CloudFoundryは、Loggregator v2 envelopeでinstance_idを定義しています。これは、CloudFoundryが発するログとメトリクスに使われます。CloudFoundryのコンポーネントについては、vm IDを含むことが想定されています。

システムコンポーネントを計装する場合、Boshスペックの値を使用すべきです。system.instance.idはspec.idに設定すべきです。