-
Notifications
You must be signed in to change notification settings - Fork 14
Create TelemetryWdmTrait definition #15
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.
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
base: master
Are you sure you want to change the base?
Changes from 1 commit
c1df19a
f4fd334
5c0267a
0d92d84
e3ffc50
5f730e2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| // | ||
| // Copyright (c) 2016 Nest Labs, Inc. | ||
| // All rights reserved. | ||
| // | ||
| // This document is the property of Nest. It is considered | ||
| // confidential and proprietary information. | ||
| // | ||
| // This document may not be reproduced or transmitted in any form, | ||
| // in whole or in part, without the express written permission of | ||
| // Nest. | ||
| // | ||
|
|
||
| // @file | ||
| // This file specifies a WDM Telemetry trait that specifies the | ||
| // various telemetry counters that are associated with WDM | ||
|
|
||
| syntax = "proto3"; | ||
|
|
||
| package weave.trait.telemetry.wdm; | ||
|
|
||
| import "wdl/wdl_options.proto"; | ||
| import "google/protobuf/timestamp.proto"; | ||
|
|
||
| option java_outer_classname = "WeaveInternalTelemetryWdmTrait"; | ||
| option objc_class_prefix = "SCM"; | ||
|
|
||
| // @brief | ||
| // TelemetryWdmTrait | ||
| // | ||
| // A telemetry trait for the WDM that specifies various counters | ||
| // associated with WDM updates and subscriptions. | ||
| // | ||
| message TelemetryWdmTrait { | ||
| option (wdl.message_type) = TRAIT; | ||
| option (wdl.trait) = { | ||
| stability: ALPHA, | ||
| id: 0x1781, | ||
| vendor_id: 0x0000, | ||
| version: 1 | ||
| }; | ||
| option (wdl.properties) = { | ||
| writable: READ_ONLY, | ||
| }; | ||
|
|
||
| // Events associated with WDM updates | ||
| message TelemetryWdmUpdateStatsEvent { | ||
|
||
| option (wdl.message_type) = EVENT; | ||
| option (wdl.event) = { | ||
| id: 1 | ||
| event_importance: EVENT_IMPORTANCE_DEBUG | ||
| }; | ||
|
|
||
| // This field holds the count of successful updates since the | ||
| // last restart. | ||
| uint32 successful_updates_count = 1; | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are these metrics aggregated across different subscriptions?
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes this is accumulated across multiple subscriptions. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So, this looks like an aggregate of all Updates(presumably unconditional and conditional). It might be good to separate conditional vs unconditional updates also? |
||
|
|
||
| // This field holds the count of unsuccessful updates since the | ||
| // last restart. | ||
| uint32 unsuccessful_updates_count = 2; | ||
|
|
||
| // This field holds the count of successful subscriptions since the | ||
| // last restart. | ||
| uint32 successful_subscriptions_count = 3; | ||
|
|
||
| // This field holds the count of subscription attempts since the | ||
| // last restart. | ||
| uint32 subscription_attempt_count = 4; | ||
|
|
||
| // This field holds the timestamp of the last update failure. | ||
| google.protobuf.Timestamp last_update_failure_time = 5 [(wdl.param) = { | ||
| timestamp_constraints: { signed: true, precision: 0.001, width: 64 } | ||
| }]; | ||
|
|
||
| // This field holds the timestamp of the last subscription failure. | ||
| google.protobuf.Timestamp last_subscription_failure_time = 6 [(wdl.param) = { | ||
| timestamp_constraints: { signed: true, precision: 0.001, width: 64 } | ||
| }]; | ||
|
|
||
|
|
||
| // This field holds the error code of the last update failure. | ||
| int32 last_update_failure_reason = 7; | ||
|
||
|
|
||
| // This field holds the profile ID of the last update failure. | ||
| uint32 last_update_failure_profile = 8; | ||
|
|
||
| // This field holds the status code of the last update failure. | ||
| uint32 last_update_failure_status_code = 9; | ||
|
|
||
| // This field holds the error code of the last subscription failure. | ||
| int32 last_subscription_failure_reason = 10; | ||
|
|
||
| } | ||
| } | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please fix the copyright header: 2020, Google LLC, Apache license.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done