Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 15f2ba2

Browse files
committed
v3: Document app/service usage event data
Add documentation for all the data subfields on app and service usage event objects. [finishes #172985876] [finishes #172985880] Authored-by: Reid Mitchell <rmitchell@pivotal.io>
1 parent 4ddd2ad commit 15f2ba2

1 file changed

Lines changed: 44 additions & 1 deletion

File tree

  • docs/v3/source/includes/experimental_resources/usage_events

docs/v3/source/includes/experimental_resources/usage_events/_object.md.erb

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,52 @@ Example of a Service Usage Event object
1313
<%= yield_content :single_service_usage_event %>
1414
```
1515

16+
There two types of usage events: app usage events and service usage events. They are distinguished by their `type` field and by the fields displayed in their `data`.
17+
18+
#### App usage events
19+
20+
Name | Type | Description
21+
---- | ---- | -----------
22+
**guid** | _uuid_ | Unique identifier for the event.
23+
**type** | _string_ | The type of the event, always "app" for app usage events
24+
**created_at** | _datetime_ | The time with zone when the event occurred
25+
**updated_at** | _datetime_ | Identical to `created_at` (events are created, never updated)
26+
**data.state.current** | _string_ or `null` | Current state of the app that this event pertains to, if applicable.
27+
**data.state.previous** | _string_ or `null` | Previous state of the app that this event pertains to, if applicable.
28+
**data.app.guid** | _string_ or `null` | Unique identifier of the app that this event pertains to, if applicable.
29+
**data.app.name** | _string_ or `null` | Name of the app that this event pertains to, if applicable.
30+
**data.process.guid** | _string_ or `null` | Unique identifier of the process that this event pertains to, if applicable.
31+
**data.process.type** | _string_ or `null` | Type of the process that this event pertains to, if applicable.
32+
**data.space.guid** | _string_ or `null` | Unique identifier of the space that this event pertains to, if applicable.
33+
**data.space.name** | _string_ or `null` | Name of the space that this event pertains to, if applicable.
34+
**data.organization.guid** | _string_ or `null` | Unique identifier of the org that this event pertains to, if applicable.
35+
**data.buildpack.guid** | _string_ or `null` | Unique identifier of the buildpack that this event pertains to, if applicable.
36+
**data.buildpack.name** | _string_ or `null` | Name of the buildpack that this event pertains to, if applicable.
37+
**data.task.guid** | _string_ or `null` | Unique identifier of the task that this event pertains to, if applicable.
38+
**data.task.name** | _string_ or `null` | Name of the task that this event pertains to, if applicable.
39+
**data.memory_in_mb_per_instance.current** | _integer_ or `null` | Current memory in MB of the app that this event pertains to, if applicable.
40+
**data.memory_in_mb_per_instance.previous** | _integer_ or `null` | Previous memory in MB of the app that this event pertains to, if applicable.
41+
**data.instance_count.current** | _integer_ or `null` | Current instance count of the app that this event pertains to, if applicable.
42+
**data.instance_count.previous** | _integer_ or `null` | Previous instance count of the app that this event pertains to, if applicable.
43+
44+
#### Service usage events
45+
1646
Name | Type | Description
1747
---- | ---- | -----------
1848
**guid** | _uuid_ | Unique identifier for the event.
19-
**type** | _string_ | The type of the event, either "app" (application event) or "service" (service event)
49+
**type** | _string_ | The type of the event, always "service" for service usage events
2050
**created_at** | _datetime_ | The time with zone when the event occurred
2151
**updated_at** | _datetime_ | Identical to `created_at` (events are created, never updated)
52+
**data.state** | _string_ or `null` | Current state of the service that this event pertains to, if applicable.
53+
**data.space.guid** | _string_ or `null` | Unique identifier of the space that this event pertains to, if applicable.
54+
**data.space.name** | _string_ or `null` | Name of the space that this event pertains to, if applicable.
55+
**data.organization.guid** | _string_ or `null` | Unique identifier of the org that this event pertains to, if applicable.
56+
**data.service_instance.guid** | _string_ or `null` | Unique identifier of the service instance that this event pertains to, if applicable.
57+
**data.service_instance.name** | _string_ or `null` | Name of the service instance that this event pertains to, if applicable.
58+
**data.service_instance.type** | _string_ or `null` | Type of the service instance that this event pertains to, if applicable.
59+
**data.service_plan.guid** | _string_ or `null` | Unique identifier of the service plan that this event pertains to, if applicable.
60+
**data.service_plan.name** | _string_ or `null` | Name of the service plan that this event pertains to, if applicable.
61+
**data.service_offering.guid** | _string_ or `null` | Unique identifier of the service offering that this event pertains to, if applicable.
62+
**data.service_offering.name** | _string_ or `null` | Name of the service offering that this event pertains to, if applicable.
63+
**data.service_broker.guid** | _string_ or `null` | Unique identifier of the service broker that this event pertains to, if applicable.
64+
**data.service_broker.name** | _string_ or `null` | Name of the service broker that this event pertains to, if applicable.

0 commit comments

Comments
 (0)