Types for Stackdriver Monitoring API Client - Google Cloud

Stackdriver Monitoring creates the condition identifiers and includes them in the new policy. When calling the [alertPolicies.update][google.monitoring.v3. OnJanuary1,2020thislibrarywillnolongersupportPython2onthelatestreleasedversion. Previouslyreleasedlibraryversionswillcontinuetobeavailable.Formoreinformationplease visitPython2supportonGoogleCloud. TypesforStackdriverMonitoringAPIClient¶ classgoogle.cloud.monitoring_v3.types.Aggregation¶ Describeshowtocombinemultipletimeseriestoprovidedifferentviews ofthedata.Aggregationconsistsofanalignmentsteponindividual timeseries(alignment_periodandper_series_aligner)followed byanoptionalreductionstepofthedataacrossthealignedtimeseries (cross_series_reducerandgroup_by_fields).Formoredetails, seeAggregation. alignment_period¶ Thealignmentperiodforper-[time series][google.monitoring.v3.TimeSeries]alignment.If present,alignmentPeriodmustbeatleast60seconds. Afterper-timeseriesalignment,eachtimeserieswillcontain datapointsonlyontheperiodboundaries.If perSeriesAlignerisnotspecifiedorequals ALIGN_NONE,thenthisfieldisignored.If perSeriesAlignerisspecifiedanddoesnotequal ALIGN_NONE,thenthisfieldmustbedefined;otherwisean errorisreturned. per_series_aligner¶ Theapproachtobeusedtoalignindividualtimeseries.Not allalignmentfunctionsmaybeappliedtoalltimeseries, dependingonthemetrictypeandvaluetypeoftheoriginal timeseries.Alignmentmaychangethemetrictypeorthevalue typeofthetimeseries.Timeseriesdatamustbealignedin ordertoperformcross-timeseriesreduction.If crossSeriesReducerisspecified,thenperSeriesAligner mustbespecifiedandnotequalALIGN_NONEand alignmentPeriodmustbespecified;otherwise,anerroris returned. cross_series_reducer¶ Theapproachtobeusedtocombinetimeseries.Notall reducerfunctionsmaybeappliedtoalltimeseries,depending onthemetrictypeandthevaluetypeoftheoriginaltime series.Reductionmaychangethemetrictypeofvaluetypeof thetimeseries.Timeseriesdatamustbealignedinorderto performcross-timeseriesreduction.IfcrossSeriesReducer isspecified,thenperSeriesAlignermustbespecifiedand notequalALIGN_NONEandalignmentPeriodmustbe specified;otherwise,anerrorisreturned. group_by_fields¶ ThesetoffieldstopreservewhencrossSeriesReduceris specified.ThegroupByFieldsdeterminehowthetimeseries arepartitionedintosubsetspriortoapplyingtheaggregation function.Eachsubsetcontainstimeseriesthathavethesame valueforeachofthegroupingfields.Eachindividualtime seriesisamemberofexactlyonesubset.The crossSeriesReducerisappliedtoeachsubsetoftime series.Itisnotpossibletoreduceacrossdifferentresource types,sothisfieldimplicitlycontainsresource.type. FieldsnotspecifiedingroupByFieldsareaggregatedaway. IfgroupByFieldsisnotspecifiedandallthetimeseries havethesameresourcetype,thenthetimeseriesare aggregatedintoasingleoutputtimeseries.If crossSeriesReducerisnotdefined,thisfieldisignored. alignment_period Fieldgoogle.monitoring.v3.Aggregation.alignment_period cross_series_reducer Fieldgoogle.monitoring.v3.Aggregation.cross_series_reducer group_by_fields Fieldgoogle.monitoring.v3.Aggregation.group_by_fields per_series_aligner Fieldgoogle.monitoring.v3.Aggregation.per_series_aligner classgoogle.cloud.monitoring_v3.types.AlertPolicy¶ Adescriptionoftheconditionsunderwhichsomeaspectofyoursystem isconsideredtobe“unhealthy”andthewaystonotifypeopleor servicesaboutthisstate.Foranoverviewofalertpolicies,see IntroductiontoAlerting. name¶ Requiredifthepolicyexists.Theresourcenameforthis policy.Thesyntaxis::: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID]isassignedbyStackdriverMonitoring whenthepolicyiscreated.Whencallingthe[alertPolicies.cr eate][google.monitoring.v3.AlertPolicyService.CreateAlertPolic y]method,donotincludethenamefieldinthealerting policypassedaspartoftherequest. display_name¶ Ashortnameorphraseusedtoidentifythepolicyin dashboards,notifications,andincidents.Toavoidconfusion, don’tusethesamedisplaynameformultiplepoliciesinthe sameproject.Thenameislimitedto512Unicodecharacters. documentation¶ Documentationthatisincludedwithnotificationsand incidentsrelatedtothispolicy.Bestpracticeisforthe documentationtoincludeinformationtohelpresponders understand,mitigate,escalate,andcorrecttheunderlying problemsdetectedbythealertingpolicy.Notification channelsthathavelimitedcapacitymightnotshowthis documentation. user_labels¶ User-suppliedkey/valuedatatobeusedfororganizingand identifyingtheAlertPolicyobjects.Thefieldcan containupto64entries.Eachkeyandvalueislimitedto63 Unicodecharactersor128bytes,whicheverissmaller.Labels andvaluescancontainonlylowercaseletters,numerals, underscores,anddashes.Keysmustbeginwithaletter. conditions¶ Alistofconditionsforthepolicy.Theconditionsare combinedbyANDorORaccordingtothecombinerfield.If thecombinedconditionsevaluatetotrue,thenanincidentis created.Apolicycanhavefromonetosixconditions. combiner¶ Howtocombinetheresultsofmultipleconditionstodetermine ifanincidentshouldbeopened. enabled¶ Whetherornotthepolicyisenabled.Onwrite,thedefault interpretationifunsetisthatthepolicyisenabled.On read,clientsshouldnotmakeanyassumptionaboutthestate ifithasnotbeenpopulated.Thefieldshouldalwaysbe populatedonListandGetoperations,unlessafield projectionhasbeenspecifiedthatstripsitout. validity¶ Read-onlydescriptionofhowthealertpolicyisinvalid.OK ifthealertpolicyisvalid.IfnotOK,thealertpolicywill notgenerateincidents. notification_channels¶ Identifiesthenotificationchannelstowhichnotifications shouldbesentwhenincidentsareopenedorclosedorwhennew violationsoccuronanalreadyopenedincident.Eachelement ofthisarraycorrespondstothenamefieldineachofthe [NotificationChannel][google.monitoring.v3.NotificationCha nnel]objectsthatarereturnedfromthe[ListNotificationCh annels][google.monitoring.v3.NotificationChannelService.List NotificationChannels]method.Thesyntaxoftheentriesin thisfieldis::: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] creation_record¶ Aread-onlyrecordofthecreationofthealertingpolicy.If providedinacalltocreateorupdate,thisfieldwillbe ignored. mutation_record¶ Aread-onlyrecordofthemostrecentchangetothealerting policy.Ifprovidedinacalltocreateorupdate,thisfield willbeignored. classCondition¶ Aconditionisatrue/falsetestthatdetermineswhenanalertingpolicy shouldopenanincident.Ifaconditionevaluatestotrue,itsignifies thatsomethingiswrong. name¶ Requirediftheconditionexists.Theuniqueresourcenamefor thiscondition.Itssyntaxis:::projects/[PROJECT_ID]/ alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID]isassignedbyStackdriverMonitoringwhen theconditioniscreatedaspartofaneworupdatedalerting policy.Whencallingthe[alertPolicies.create][google.monito ring.v3.AlertPolicyService.CreateAlertPolicy]method,donot includethenamefieldintheconditionsoftherequested alertingpolicy.StackdriverMonitoringcreatesthecondition identifiersandincludestheminthenewpolicy.Whencalling the[alertPolicies.update][google.monitoring.v3.AlertPolicySer vice.UpdateAlertPolicy]methodtoupdateapolicy,includinga conditionnamecausestheexistingconditiontobe updated.Conditionswithoutnamesareaddedtotheupdated policy.Existingconditionsaredeletediftheyarenot updated.Bestpracticeistopreserve[CONDITION_ID]if youmakeonlysmallchanges,suchasthosetocondition thresholds,durations,ortriggervalues.Otherwise,treatthe changeasanewconditionandlettheexistingconditionbe deleted. display_name¶ Ashortnameorphraseusedtoidentifytheconditionin dashboards,notifications,andincidents.Toavoidconfusion, don’tusethesamedisplaynameformultipleconditionsinthe samepolicy. condition¶ Onlyoneofthefollowingconditiontypeswillbespecified. condition_threshold¶ Aconditionthatcomparesatimeseriesagainstathreshold. condition_absent¶ Aconditionthatchecksthatatimeseriescontinuesto receivenewdatapoints. classMetricAbsence¶ Aconditiontypethatchecksthatmonitoredresourcesarereporting data.Theconfigurationdefinesametricandasetofmonitored resources.Thepredicateisconsideredinviolationwhenatimeseries forthespecifiedmetricofamonitoredresourcedoesnotincludeany datainthespecifiedduration. filter¶ Afilterthatidentifies whichtimeseriesshouldbecomparedwiththethreshold.The filterissimilartotheonethatisspecifiedinthe `ListTimeSeriesrequest `__ (thatcallisusefultoverifythetimeseriesthatwillbe retrieved/processed)andmustspecifythemetrictypeand optionallymaycontainrestrictionsonresourcetype,resource labels,andmetriclabels.Thisfieldmaynotexceed2048 Unicodecharactersinlength. aggregations¶ Specifiesthealignmentofdatapointsinindividualtime seriesaswellashowtocombinetheretrievedtimeseries together(suchaswhenaggregatingmultiplestreamsoneach resourcetoasinglestreamforeachresourceorwhen aggregatingstreamsacrossallmembersofagroupof resrouces).Multipleaggregationsareappliedintheorder specified.Thisfieldissimilartotheoneinthe `ListTimeSeriesrequest `__. ItisadvisabletousetheListTimeSeriesmethodwhen debuggingthisfield. duration¶ Theamountoftimethatatimeseriesmustfailtoreportnew datatobeconsideredfailing.Currently,onlyvaluesthatare amultipleofaminute–e.g.60,120,or300seconds–are supported.Ifaninvalidvalueisgiven,anerrorwillbe returned.TheDuration.nanosfieldisignored. trigger¶ Thenumber/percentoftimeseriesforwhichthecomparison mustholdinorderfortheconditiontotrigger.If unspecified,thentheconditionwilltriggerifthecomparison istrueforanyofthetimeseriesthathavebeenidentified byfilterandaggregations. aggregations Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricAbsence.aggregations duration Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricAbsence.duration filter Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricAbsence.filter trigger Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricAbsence.trigger classMetricThreshold¶ Aconditiontypethatcomparesacollectionoftimeseriesagainsta threshold. filter¶ Afilterthatidentifies whichtimeseriesshouldbecomparedwiththethreshold.The filterissimilartotheonethatisspecifiedinthe `ListTimeSeriesrequest `__ (thatcallisusefultoverifythetimeseriesthatwillbe retrieved/processed)andmustspecifythemetrictypeand optionallymaycontainrestrictionsonresourcetype,resource labels,andmetriclabels.Thisfieldmaynotexceed2048 Unicodecharactersinlength. aggregations¶ Specifiesthealignmentofdatapointsinindividualtime seriesaswellashowtocombinetheretrievedtimeseries together(suchaswhenaggregatingmultiplestreamsoneach resourcetoasinglestreamforeachresourceorwhen aggregatingstreamsacrossallmembersofagroupof resrouces).Multipleaggregationsareappliedintheorder specified.Thisfieldissimilartotheoneinthe `ListTimeSeriesrequest `__. ItisadvisabletousetheListTimeSeriesmethodwhen debuggingthisfield. denominator_filter¶ Afilterthatidentifiesa timeseriesthatshouldbeusedasthedenominatorofaratio thatwillbecomparedwiththethreshold.Ifa denominator_filterisspecified,thetimeseriesspecified bythefilterfieldwillbeusedasthenumerator.The filtermustspecifythemetrictypeandoptionallymaycontain restrictionsonresourcetype,resourcelabels,andmetric labels.Thisfieldmaynotexceed2048Unicodecharactersin length. denominator_aggregations¶ Specifiesthealignmentofdatapointsinindividualtime seriesselectedbydenominatorFilteraswellashowto combinetheretrievedtimeseriestogether(suchaswhen aggregatingmultiplestreamsoneachresourcetoasingle streamforeachresourceorwhenaggregatingstreamsacross allmembersofagroupofresources).Whencomputingratios, theaggregationsanddenominator_aggregationsfields mustusethesamealignmentperiodandproducetimeseries thathavethesameperiodicityandlabels. comparison¶ Thecomparisontoapplybetweenthetimeseries(indicatedby filterandaggregation)andthethreshold(indicated bythreshold_value).Thecomparisonisappliedoneach timeseries,withthetimeseriesontheleft-handsideand thethresholdontheright-handside.OnlyCOMPARISON_LT andCOMPARISON_GTaresupportedcurrently. threshold_value¶ Avalueagainstwhichtocomparethetimeseries. duration¶ Theamountoftimethatatimeseriesmustviolatethe thresholdtobeconsideredfailing.Currently,onlyvalues thatareamultipleofaminute–e.g.,0,60,120,or300 seconds–aresupported.Ifaninvalidvalueisgiven,anerror willbereturned.Whenchoosingaduration,itisusefulto keepinmindthefrequencyoftheunderlyingtimeseriesdata (whichmayalsobeaffectedbyanyalignmentsspecifiedinthe aggregationsfield);agooddurationislongenoughso thatasingleoutlierdoesnotgeneratespuriousalerts,but shortenoughthatunhealthystatesaredetectedandalertedon quickly. trigger¶ Thenumber/percentoftimeseriesforwhichthecomparison mustholdinorderfortheconditiontotrigger.If unspecified,thentheconditionwilltriggerifthecomparison istrueforanyofthetimeseriesthathavebeenidentified byfilterandaggregations,orbytheratio,if denominator_filteranddenominator_aggregationsare specified. aggregations Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricThreshold.aggregations comparison Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricThreshold.comparison denominator_aggregations Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricThreshold.denominator_aggregations denominator_filter Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricThreshold.denominator_filter duration Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricThreshold.duration filter Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricThreshold.filter threshold_value Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricThreshold.threshold_value trigger Fieldgoogle.monitoring.v3.AlertPolicy.Condition.MetricThreshold.trigger classTrigger¶ Specifieshowmanytimeseriesmustfailapredicatetotriggera condition.Ifnotspecified,thena{count:1}triggerisused. type¶ Atypeoftrigger. count¶ Theabsolutenumberoftimeseriesthatmustfailthe predicatefortheconditiontobetriggered. percent¶ Thepercentageoftimeseriesthatmustfailthepredicatefor theconditiontobetriggered. count Fieldgoogle.monitoring.v3.AlertPolicy.Condition.Trigger.count percent Fieldgoogle.monitoring.v3.AlertPolicy.Condition.Trigger.percent condition_absent Fieldgoogle.monitoring.v3.AlertPolicy.Condition.condition_absent condition_threshold Fieldgoogle.monitoring.v3.AlertPolicy.Condition.condition_threshold display_name Fieldgoogle.monitoring.v3.AlertPolicy.Condition.display_name name Fieldgoogle.monitoring.v3.AlertPolicy.Condition.name classDocumentation¶ AcontentstringandaMIMEtypethatdescribesthecontentstring’s format. content¶ Thetextofthedocumentation,interpretedaccordingto mime_type.Thecontentmaynotexceed8,192Unicode charactersandmaynotexceedmorethan10,240byteswhen encodedinUTF-8format,whicheverissmaller. mime_type¶ Theformatofthecontentfield.Presently,onlythevalue "text/markdown"issupported.SeeMarkdownformore information. content Fieldgoogle.monitoring.v3.AlertPolicy.Documentation.content mime_type Fieldgoogle.monitoring.v3.AlertPolicy.Documentation.mime_type classUserLabelsEntry¶ key¶ Fieldgoogle.monitoring.v3.AlertPolicy.UserLabelsEntry.key value¶ Fieldgoogle.monitoring.v3.AlertPolicy.UserLabelsEntry.value combiner Fieldgoogle.monitoring.v3.AlertPolicy.combiner conditions Fieldgoogle.monitoring.v3.AlertPolicy.conditions creation_record Fieldgoogle.monitoring.v3.AlertPolicy.creation_record display_name Fieldgoogle.monitoring.v3.AlertPolicy.display_name documentation Fieldgoogle.monitoring.v3.AlertPolicy.documentation enabled Fieldgoogle.monitoring.v3.AlertPolicy.enabled mutation_record Fieldgoogle.monitoring.v3.AlertPolicy.mutation_record name Fieldgoogle.monitoring.v3.AlertPolicy.name notification_channels Fieldgoogle.monitoring.v3.AlertPolicy.notification_channels user_labels Fieldgoogle.monitoring.v3.AlertPolicy.user_labels validity Fieldgoogle.monitoring.v3.AlertPolicy.validity classgoogle.cloud.monitoring_v3.types.Any¶ type_url¶ Fieldgoogle.protobuf.Any.type_url value¶ Fieldgoogle.protobuf.Any.value classgoogle.cloud.monitoring_v3.types.BasicSli¶ AnSLImeasuringperformanceonawell-knownservicetype.Performance willbecomputedonthebasisofpre-definedmetrics.Thetypeofthe service_resourcedeterminesthemetricstouseandthe service_resource.labelsandmetric_labelsareusedtoconstruct amonitoringfiltertofilterthatmetricdowntojustthedatarelevant tothisservice. method¶ OPTIONAL:ThesetofRPCstowhichthisSLIisrelevant. Telemetryfromothermethodswillnotbeusedtocalculate performanceforthisSLI.Ifomitted,thisSLIappliestoall theService’smethods.Forservicetypesthatdon’tsupport breakingdownbymethod,settingthisfieldwillresultinan error. location¶ OPTIONAL:ThesetoflocationstowhichthisSLIisrelevant. Telemetryfromotherlocationswillnotbeusedtocalculate performanceforthisSLI.Ifomitted,thisSLIappliestoall locationsinwhichtheServicehasactivity.Forservicetypes thatdon’tsupportbreakingdownbylocation,settingthis fieldwillresultinanerror. version¶ OPTIONAL:ThesetofAPIversionstowhichthisSLIis relevant.TelemetryfromotherAPIversionswillnotbeused tocalculateperformanceforthisSLI.Ifomitted,thisSLI appliestoallAPIversions.Forservicetypesthatdon’t supportbreakingdownbyversion,settingthisfieldwill resultinanerror. sli_criteria¶ ThisSLIcanbeevaluatedonthebasisofavailabilityor latency. availability¶ Goodserviceisdefinedtobethecountofrequestsmadeto thisservicethatreturnsuccessfully. latency¶ Goodserviceisdefinedtobethecountofrequestsmadeto thisservicethatarefastenoughwithrespectto latency.threshold. classAvailabilityCriteria¶ FutureparametersfortheavailabilitySLI. classLatencyCriteria¶ ParametersforalatencythresholdSLI. threshold¶ Goodserviceisdefinedtobethecountofrequestsmadeto thisservicethatreturninnomorethanthreshold. threshold Fieldgoogle.monitoring.v3.BasicSli.LatencyCriteria.threshold availability Fieldgoogle.monitoring.v3.BasicSli.availability latency Fieldgoogle.monitoring.v3.BasicSli.latency location Fieldgoogle.monitoring.v3.BasicSli.location method Fieldgoogle.monitoring.v3.BasicSli.method version Fieldgoogle.monitoring.v3.BasicSli.version classgoogle.cloud.monitoring_v3.types.BoolValue¶ value¶ Fieldgoogle.protobuf.BoolValue.value classgoogle.cloud.monitoring_v3.types.BytesValue¶ value¶ Fieldgoogle.protobuf.BytesValue.value classgoogle.cloud.monitoring_v3.types.CreateAlertPolicyRequest¶ TheprotocolfortheCreateAlertPolicyrequest. name¶ Theprojectinwhichtocreatethealertingpolicy.Theformat isprojects/[PROJECT_ID].Notethatthisfieldnamesthe parentcontainerinwhichthealertingpolicywillbewritten, notthenameofthecreatedpolicy.Thealertingpolicythat isreturnedwillhaveanamethatcontainsanormalized representationofthisnameasaprefixbutaddsasuffixof theform/alertPolicies/[POLICY_ID],identifyingthe policyinthecontainer. alert_policy¶ Therequestedalertingpolicy.Youshouldomitthename fieldinthispolicy.Thenamewillbereturnedinthenew policy,includinganew[ALERT_POLICY_ID]value. alert_policy Fieldgoogle.monitoring.v3.CreateAlertPolicyRequest.alert_policy name Fieldgoogle.monitoring.v3.CreateAlertPolicyRequest.name classgoogle.cloud.monitoring_v3.types.CreateGroupRequest¶ TheCreateGrouprequest. name¶ Theprojectinwhichtocreatethegroup.Theformatis "projects/{project_id_or_number}". group¶ Agroupdefinition.Itisanerrortodefinethename fieldbecausethesystemassignsthename. validate_only¶ Iftrue,validatethisrequestbutdonotcreatethegroup. group Fieldgoogle.monitoring.v3.CreateGroupRequest.group name Fieldgoogle.monitoring.v3.CreateGroupRequest.name validate_only Fieldgoogle.monitoring.v3.CreateGroupRequest.validate_only classgoogle.cloud.monitoring_v3.types.CreateMetricDescriptorRequest¶ TheCreateMetricDescriptorrequest. name¶ Theprojectonwhichtoexecutetherequest.Theformatis "projects/{project_id_or_number}". metric_descriptor¶ Thenewcustommetric descriptor. metric_descriptor Fieldgoogle.monitoring.v3.CreateMetricDescriptorRequest.metric_descriptor name Fieldgoogle.monitoring.v3.CreateMetricDescriptorRequest.name classgoogle.cloud.monitoring_v3.types.CreateNotificationChannelRequest¶ TheCreateNotificationChannelrequest. name¶ Theprojectonwhichtoexecutetherequest.Theformatis: ::projects/[PROJECT_ID]Notethatthisnamesthe containerintowhichthechannelwillbewritten.Thisdoes notnamethenewlycreatedchannel.Theresultingchannel’s namewillhaveanormalizedversionofthisfieldasaprefix, butwilladd/notificationChannels/[CHANNEL_ID]to identifythechannel. notification_channel¶ ThedefinitionoftheNotificationChanneltocreate. name Fieldgoogle.monitoring.v3.CreateNotificationChannelRequest.name notification_channel Fieldgoogle.monitoring.v3.CreateNotificationChannelRequest.notification_channel classgoogle.cloud.monitoring_v3.types.CreateServiceLevelObjectiveRequest¶ TheCreateServiceLevelObjectiverequest. parent¶ ResourcenameoftheparentService.Oftheform projects/{project_id}/services/{service_id}. service_level_objective_id¶ Optional.TheServiceLevelObjectiveidtouseforthis ServiceLevelObjective.Ifomitted,anidwillbegenerated instead.Mustmatchthepattern[a-z0-9-]+ service_level_objective¶ TheServiceLevelObjectivetocreate.Theprovidedname willberespectedifnoServiceLevelObjectiveexistswith thisname. parent Fieldgoogle.monitoring.v3.CreateServiceLevelObjectiveRequest.parent service_level_objective Fieldgoogle.monitoring.v3.CreateServiceLevelObjectiveRequest.service_level_objective service_level_objective_id Fieldgoogle.monitoring.v3.CreateServiceLevelObjectiveRequest.service_level_objective_id classgoogle.cloud.monitoring_v3.types.CreateServiceRequest¶ TheCreateServicerequest. parent¶ Resourcenameoftheparentworkspace.Oftheform projects/{project_id}. service_id¶ Optional.TheServiceidtouseforthisService.Ifomitted, anidwillbegeneratedinstead.Mustmatchthepattern [a-z0-9-]+ service¶ TheServicetocreate. parent Fieldgoogle.monitoring.v3.CreateServiceRequest.parent service Fieldgoogle.monitoring.v3.CreateServiceRequest.service service_id Fieldgoogle.monitoring.v3.CreateServiceRequest.service_id classgoogle.cloud.monitoring_v3.types.CreateTimeSeriesError¶ DEPRECATED.Usedtoholdper-time-serieserrorstatus. time_series¶ DEPRECATED.TimeseriesIDthatresultedinthestatus error. status¶ DEPRECATED.Thestatusoftherequestedwriteoperationfor time_series. status Fieldgoogle.monitoring.v3.CreateTimeSeriesError.status time_series Fieldgoogle.monitoring.v3.CreateTimeSeriesError.time_series classgoogle.cloud.monitoring_v3.types.CreateTimeSeriesRequest¶ TheCreateTimeSeriesrequest. name¶ Theprojectonwhichtoexecutetherequest.Theformatis "projects/{project_id_or_number}". time_series¶ Thenewdatatobeaddedtoalistoftimeseries.Addsat mostonedatapointtoeachofseveraltimeseries.Thenew datapointmustbemorerecentthananyotherpointinits timeseries.EachTimeSeriesvaluemustfullyspecifya uniquetimeseriesbysupplyingalllabelvaluesforthe metricandthemonitoredresource.Themaximumnumberof TimeSeriesobjectsperCreaterequestis200. name Fieldgoogle.monitoring.v3.CreateTimeSeriesRequest.name time_series Fieldgoogle.monitoring.v3.CreateTimeSeriesRequest.time_series classgoogle.cloud.monitoring_v3.types.CreateTimeSeriesSummary¶ Summaryoftheresultofafailedrequesttowritedatatoatime series. total_point_count¶ Thenumberofpointsintherequest. success_point_count¶ Thenumberofpointsthatweresuccessfullywritten. errors¶ Thenumberofpointsthatfailedtobewritten.Orderisnot guaranteed. classError¶ Detailedinformationaboutanerrorcategory. status¶ Thestatusoftherequestedwriteoperation. point_count¶ Thenumberofpointsthatcouldn’tbewrittenbecauseof status. point_count Fieldgoogle.monitoring.v3.CreateTimeSeriesSummary.Error.point_count status Fieldgoogle.monitoring.v3.CreateTimeSeriesSummary.Error.status errors Fieldgoogle.monitoring.v3.CreateTimeSeriesSummary.errors success_point_count Fieldgoogle.monitoring.v3.CreateTimeSeriesSummary.success_point_count total_point_count Fieldgoogle.monitoring.v3.CreateTimeSeriesSummary.total_point_count classgoogle.cloud.monitoring_v3.types.CreateUptimeCheckConfigRequest¶ TheprotocolfortheCreateUptimeCheckConfigrequest. parent¶ TheprojectinwhichtocreatetheUptimecheck.Theformatis projects/[PROJECT_ID]. uptime_check_config¶ ThenewUptimecheckconfiguration. parent Fieldgoogle.monitoring.v3.CreateUptimeCheckConfigRequest.parent uptime_check_config Fieldgoogle.monitoring.v3.CreateUptimeCheckConfigRequest.uptime_check_config classgoogle.cloud.monitoring_v3.types.DeleteAlertPolicyRequest¶ TheprotocolfortheDeleteAlertPolicyrequest. name¶ Thealertingpolicytodelete.Theformatis:::projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]For moreinformation,see [AlertPolicy][google.monitoring.v3.AlertPolicy]. name Fieldgoogle.monitoring.v3.DeleteAlertPolicyRequest.name classgoogle.cloud.monitoring_v3.types.DeleteGroupRequest¶ TheDeleteGrouprequest.Thedefaultbehavioristobeableto deleteasinglegroupwithoutanydescendants. name¶ Thegrouptodelete.Theformatis "projects/{project_id_or_number}/groups/{group_id}". recursive¶ Ifthisfieldistrue,thentherequestmeanstodeletea groupwithallitsdescendants.Otherwise,therequestmeans todeleteagrouponlywhenithasnodescendants.Thedefault valueisfalse. name Fieldgoogle.monitoring.v3.DeleteGroupRequest.name recursive Fieldgoogle.monitoring.v3.DeleteGroupRequest.recursive classgoogle.cloud.monitoring_v3.types.DeleteMetricDescriptorRequest¶ TheDeleteMetricDescriptorrequest. name¶ Themetricdescriptoronwhichtoexecutetherequest.The formatis"projects/{project_id_or_number}/metricDescriptors /{metric_id}".Anexampleof{metric_id}is: "custom.googleapis.com/my_test_metric". name Fieldgoogle.monitoring.v3.DeleteMetricDescriptorRequest.name classgoogle.cloud.monitoring_v3.types.DeleteNotificationChannelRequest¶ TheDeleteNotificationChannelrequest. name¶ Thechannelforwhichtoexecutetherequest.Theformatis projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. force¶ Iftrue,thenotificationchannelwillbedeletedregardless ofitsuseinalertpolicies(thepolicieswillbeupdatedto removethechannel).Iffalse,channelsthatarestill referencedbyanexistingalertingpolicywillfailtobe deletedinadeleteoperation. force Fieldgoogle.monitoring.v3.DeleteNotificationChannelRequest.force name Fieldgoogle.monitoring.v3.DeleteNotificationChannelRequest.name classgoogle.cloud.monitoring_v3.types.DeleteServiceLevelObjectiveRequest¶ TheDeleteServiceLevelObjectiverequest. name¶ ResourcenameoftheServiceLevelObjectivetodelete.Of theformprojects/{project_id}/services/{service_id}/service LevelObjectives/{slo_name}. name Fieldgoogle.monitoring.v3.DeleteServiceLevelObjectiveRequest.name classgoogle.cloud.monitoring_v3.types.DeleteServiceRequest¶ TheDeleteServicerequest. name¶ ResourcenameoftheServicetodelete.Oftheform projects/{project_id}/service/{service_id}. name Fieldgoogle.monitoring.v3.DeleteServiceRequest.name classgoogle.cloud.monitoring_v3.types.DeleteUptimeCheckConfigRequest¶ TheprotocolfortheDeleteUptimeCheckConfigrequest. name¶ TheUptimecheckconfigurationtodelete.Theformatisproj ects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. name Fieldgoogle.monitoring.v3.DeleteUptimeCheckConfigRequest.name classgoogle.cloud.monitoring_v3.types.Distribution¶ classBucketOptions¶ classExplicit¶ bounds¶ Fieldgoogle.api.Distribution.BucketOptions.Explicit.bounds classExponential¶ growth_factor¶ Fieldgoogle.api.Distribution.BucketOptions.Exponential.growth_factor num_finite_buckets¶ Fieldgoogle.api.Distribution.BucketOptions.Exponential.num_finite_buckets scale¶ Fieldgoogle.api.Distribution.BucketOptions.Exponential.scale classLinear¶ num_finite_buckets¶ Fieldgoogle.api.Distribution.BucketOptions.Linear.num_finite_buckets offset¶ Fieldgoogle.api.Distribution.BucketOptions.Linear.offset width¶ Fieldgoogle.api.Distribution.BucketOptions.Linear.width explicit_buckets¶ Fieldgoogle.api.Distribution.BucketOptions.explicit_buckets exponential_buckets¶ Fieldgoogle.api.Distribution.BucketOptions.exponential_buckets linear_buckets¶ Fieldgoogle.api.Distribution.BucketOptions.linear_buckets classExemplar¶ attachments¶ Fieldgoogle.api.Distribution.Exemplar.attachments timestamp¶ Fieldgoogle.api.Distribution.Exemplar.timestamp value¶ Fieldgoogle.api.Distribution.Exemplar.value classRange¶ max¶ Fieldgoogle.api.Distribution.Range.max min¶ Fieldgoogle.api.Distribution.Range.min bucket_counts¶ Fieldgoogle.api.Distribution.bucket_counts bucket_options¶ Fieldgoogle.api.Distribution.bucket_options count¶ Fieldgoogle.api.Distribution.count exemplars¶ Fieldgoogle.api.Distribution.exemplars mean¶ Fieldgoogle.api.Distribution.mean range¶ Fieldgoogle.api.Distribution.range sum_of_squared_deviation¶ Fieldgoogle.api.Distribution.sum_of_squared_deviation classgoogle.cloud.monitoring_v3.types.DistributionCut¶ ADistributionCutdefinesaTimeSeriesandthresholdsusedfor measuringgoodserviceandtotalservice.TheTimeSeriesmusthave ValueType=DISTRIBUTIONandMetricKind=DELTAor MetricKind=CUMULATIVE.Thecomputedgood_servicewillbethe countofvaluesxintheDistributionsuchthat range.min<=x=range.min”isdesired, setrange.max=infinity. min¶ Rangeminimum. max¶ Rangemaximum. max Fieldgoogle.monitoring.v3.Range.max min Fieldgoogle.monitoring.v3.Range.min classgoogle.cloud.monitoring_v3.types.RequestBasedSli¶ ServiceLevelIndicatorsforwhichatomicunitsofservicearecounted directly. method¶ Themeanstocomputearatioofgood_serviceto total_service. good_total_ratio¶ good_total_ratioisusedwhentheratioof good_servicetototal_serviceiscomputedfromtwo TimeSeries. distribution_cut¶ distribution_cutisusedwhengood_serviceisacount ofvaluesaggregatedinaDistributionthatfallintoa goodrange.Thetotal_serviceisthetotalcountofall valuesaggregatedintheDistribution. distribution_cut Fieldgoogle.monitoring.v3.RequestBasedSli.distribution_cut good_total_ratio Fieldgoogle.monitoring.v3.RequestBasedSli.good_total_ratio classgoogle.cloud.monitoring_v3.types.SendNotificationChannelVerificationCodeRequest¶ TheSendNotificationChannelVerificationCoderequest. name¶ Thenotificationchanneltowhichtosendaverificationcode. name Fieldgoogle.monitoring.v3.SendNotificationChannelVerificationCodeRequest.name classgoogle.cloud.monitoring_v3.types.Service¶ AServiceisadiscrete,autonomous,andnetwork-accessibleunit, designedtosolveanindividualconcern (Wikipedia).In StackdriverMonitoring,aServiceactsastherootresourceunder whichoperationalaspectsoftheserviceareaccessible. name¶ ResourcenameforthisService.Oftheform projects/{project_id}/services/{service_id}. display_name¶ NameusedforUIelementslistingthisService. identifier¶ REQUIRED.Service-identifyingatomsspecifyingtheunderlying service. custom¶ Customservicetype. app_engine¶ TypeusedforAppEngineservices. cloud_endpoints¶ TypeusedforCloudEndpointsservices. cluster_istio¶ TypeusedforIstioservicesthatliveinaKubernetes cluster. telemetry¶ ConfigurationforhowtoquerytelemetryonaService. classAppEngine¶ AppEngineservice.Learnmoreathttps://cloud.google.com/appengine. module_id¶ TheIDoftheAppEnginemoduleunderlyingthisservice. Correspondstothemodule_idresourcelabelinthe gae_appmonitoredresource:https://cloud.google.com/monit oring/api/resources#tag_gae_app module_id Fieldgoogle.monitoring.v3.Service.AppEngine.module_id classCloudEndpoints¶ CloudEndpointsservice.Learnmoreat https://cloud.google.com/endpoints. service¶ ThenameoftheCloudEndpointsserviceunderlyingthis service.Correspondstotheserviceresourcelabelinthe apimonitoredresource: https://cloud.google.com/monitoring/api/resources#tag_api service Fieldgoogle.monitoring.v3.Service.CloudEndpoints.service classClusterIstio¶ Istioservice.Learnmoreathttp://istio.io. location¶ ThelocationoftheKubernetesclusterinwhichthisIstio serviceisdefined.Correspondstothelocationresource labelink8s_clusterresources. cluster_name¶ ThenameoftheKubernetesclusterinwhichthisIstioservice isdefined.Correspondstothecluster_nameresourcelabel ink8s_clusterresources. service_namespace¶ ThenamespaceoftheIstioserviceunderlyingthisservice. Correspondstothedestination_service_namespacemetric labelinIstiometrics. service_name¶ ThenameoftheIstioserviceunderlyingthisservice. Correspondstothedestination_service_namemetriclabel inIstiometrics. cluster_name Fieldgoogle.monitoring.v3.Service.ClusterIstio.cluster_name location Fieldgoogle.monitoring.v3.Service.ClusterIstio.location service_name Fieldgoogle.monitoring.v3.Service.ClusterIstio.service_name service_namespace Fieldgoogle.monitoring.v3.Service.ClusterIstio.service_namespace classCustom¶ Customviewofservicetelemetry.Currentlyaplace-holderpendingfinal design. classTelemetry¶ ConfigurationforhowtoquerytelemetryonaService. resource_name¶ Thefullnameoftheresourcethatdefinesthisservice. Formattedasdescribedin https://cloud.google.com/apis/design/resource_names. resource_name Fieldgoogle.monitoring.v3.Service.Telemetry.resource_name app_engine Fieldgoogle.monitoring.v3.Service.app_engine cloud_endpoints Fieldgoogle.monitoring.v3.Service.cloud_endpoints cluster_istio Fieldgoogle.monitoring.v3.Service.cluster_istio custom Fieldgoogle.monitoring.v3.Service.custom display_name Fieldgoogle.monitoring.v3.Service.display_name name Fieldgoogle.monitoring.v3.Service.name telemetry Fieldgoogle.monitoring.v3.Service.telemetry classgoogle.cloud.monitoring_v3.types.ServiceLevelIndicator¶ AService-LevelIndicator(SLI)describesthe“performance”ofa service.Forsomeservices,theSLIiswell-defined.Insuchcases,the SLIcanbedescribedeasilybyreferencingthewell-knownSLIand providingtheneededparameters.Alternatively,a“custom”SLIcanbe definedwithaquerytotheunderlyingmetricstore.AnSLIisdefined tobegood_service/total_serviceoveranyqueriedtimeinterval. Thevalueofperformancealwaysfallsintotherange 0<=performance<=1.AcustomSLIdescribeshowtocomputethis ratio,whetherthisisbydividingvaluesfromapairoftimeseries, cuttingaDistributionintogoodandbadcounts,orcountingtime windowsinwhichtheservicecomplieswithacriterion.Forseparation ofconcerns,asingleService-LevelIndicatormeasuresperformancefor onlyoneaspectofservicequality,suchasfractionofsuccessful queriesorfast-enoughqueries. type¶ Servicelevelindicatorscanbegroupedbywhetherthe“unit” ofservicebeingmeasuredisbasedoncountsofgoodrequests oroncountsofgoodtimewindows basic_sli¶ BasicSLIonawell-knownservicetype. request_based¶ Request-basedSLIs windows_based¶ Windows-basedSLIs basic_sli Fieldgoogle.monitoring.v3.ServiceLevelIndicator.basic_sli request_based Fieldgoogle.monitoring.v3.ServiceLevelIndicator.request_based windows_based Fieldgoogle.monitoring.v3.ServiceLevelIndicator.windows_based classgoogle.cloud.monitoring_v3.types.ServiceLevelObjective¶ AService-LevelObjective(SLO)describesalevelofdesiredgood service.Itconsistsofaservice-levelindicator(SLI),aperformance goal,andaperiodoverwhichtheobjectiveistobeevaluatedagainst thatgoal.TheSLOcanuseSLIsdefinedinanumberofdifferent manners.TypicalSLOsmightinclude“99%ofrequestsineachrolling weekhavelatencybelow200milliseconds”or“99.5%ofrequestsineach calendarmonthreturnsuccessfully.” name¶ ResourcenameforthisServiceLevelObjective.Oftheform projects/{project_id}/services/{service_id}/serviceLevelObje ctives/{slo_name}. display_name¶ NameusedforUIelementslistingthisSLO. service_level_indicator¶ Thedefinitionofgoodservice,usedtomeasureandcalculate thequalityoftheService’sperformancewithrespecttoa singleaspectofservicequality. goal¶ Thefractionofservicethatmustbegoodinorderforthis objectivetobemet.0”.Mustbeanintegermultipleof1dayno largerthan30days. calendar_period¶ Acalendarperiod,semantically“sincethestartofthe current”.Atthistime,onlyDAY, WEEK,FORTNIGHT,andMONTHaresupported. calendar_period Fieldgoogle.monitoring.v3.ServiceLevelObjective.calendar_period display_name Fieldgoogle.monitoring.v3.ServiceLevelObjective.display_name goal Fieldgoogle.monitoring.v3.ServiceLevelObjective.goal name Fieldgoogle.monitoring.v3.ServiceLevelObjective.name rolling_period Fieldgoogle.monitoring.v3.ServiceLevelObjective.rolling_period service_level_indicator Fieldgoogle.monitoring.v3.ServiceLevelObjective.service_level_indicator classgoogle.cloud.monitoring_v3.types.SpanContext¶ Thecontextofaspan,attachedtogoogle.api.Distribution.Exemplarsin google.api.Distributionvaluesduringaggregation. Itcontainsthenameofaspanwithformat: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] span_name¶ Theresourcenameofthespaninthefollowingformat:::projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] [TRACE_ID]isauniqueidentifierforatracewithina project;itisa32-characterhexadecimalencodingofa 16-bytearray.[SPAN_ID]isauniqueidentifierforaspan withinatrace;itisa16-characterhexadecimalencodingof an8-bytearray. span_name Fieldgoogle.monitoring.v3.SpanContext.span_name classgoogle.cloud.monitoring_v3.types.Status¶ code¶ Fieldgoogle.rpc.Status.code details¶ Fieldgoogle.rpc.Status.details message¶ Fieldgoogle.rpc.Status.message classgoogle.cloud.monitoring_v3.types.StringValue¶ value¶ Fieldgoogle.protobuf.StringValue.value classgoogle.cloud.monitoring_v3.types.Struct¶ classFieldsEntry¶ key¶ Fieldgoogle.protobuf.Struct.FieldsEntry.key value¶ Fieldgoogle.protobuf.Struct.FieldsEntry.value fields¶ Fieldgoogle.protobuf.Struct.fields classgoogle.cloud.monitoring_v3.types.TimeInterval¶ Aclosedtimeinterval.Itextendsfromthestarttimetotheendtime, andincludesboth:[startTime,endTime].Validtimeintervalsdepend onthe `MetricKind`__ ofthemetricvalue.Innocasecantheendtimebeearlierthanthe starttime. ForaGAUGEmetric,thestartTimevalueistechnically optional;ifnovalueisspecified,thestarttimedefaultstothe valueoftheendtime,andtheintervalrepresentsasinglepointin time.Ifbothstartandendtimesarespecified,theymustbe identical.SuchanintervalisvalidonlyforGAUGEmetrics, whicharepoint-in-timemeasurements. ForDELTAandCUMULATIVEmetrics,thestarttimemustbe earlierthantheendtime. Inallcases,thestarttimeofthenextintervalmustbeatleasta microsecondaftertheendtimeofthepreviousinterval.Becausethe intervalisclosed,ifthestarttimeofanewintervalisthesame astheendtimeofthepreviousinterval,datawrittenatthenew starttimecouldoverwritedatawrittenatthepreviousendtime. end_time¶ Required.Theendofthetimeinterval. start_time¶ Optional.Thebeginningofthetimeinterval.Thedefault valueforthestarttimeistheendtime.Thestarttimemust notbelaterthantheendtime. end_time Fieldgoogle.monitoring.v3.TimeInterval.end_time start_time Fieldgoogle.monitoring.v3.TimeInterval.start_time classgoogle.cloud.monitoring_v3.types.TimeSeries¶ Acollectionofdatapointsthatdescribesthetime-varyingvaluesofa metric.Atimeseriesisidentifiedbyacombinationofa fully-specifiedmonitoredresourceandafully-specifiedmetric.This typeisusedforbothlistingandcreatingtimeseries. metric¶ Theassociatedmetric.Afully-specifiedmetricusedto identifythetimeseries. resource¶ Theassociatedmonitoredresource.Custommetricscanuseonly certainmonitoredresourcetypesintheirtimeseriesdata. metadata¶ Outputonly.Theassociatedmonitoredresourcemetadata.When readingaatimeseries,thisfieldwillincludemetadata labelsthatareexplicitlynamedinthereduction.When creatingatimeseries,thisfieldisignored. metric_kind¶ Themetrickindofthetimeseries.Whenlistingtimeseries, thismetrickindmightbedifferentfromthemetrickindof theassociatedmetricifthistimeseriesisanalignmentor reductionofothertimeseries.Whencreatingatimeseries, thisfieldisoptional.Ifpresent,itmustbethesameasthe metrickindoftheassociatedmetric.Iftheassociated metric’sdescriptormustbeauto-created,thenthisfield specifiesthemetrickindofthenewdescriptorandmustbe eitherGAUGE(thedefault)orCUMULATIVE. value_type¶ Thevaluetypeofthetimeseries.Whenlistingtimeseries, thisvaluetypemightbedifferentfromthevaluetypeofthe associatedmetricifthistimeseriesisanalignmentor reductionofothertimeseries.Whencreatingatimeseries, thisfieldisoptional.Ifpresent,itmustbethesameasthe typeofthedatainthepointsfield. points¶ Thedatapointsofthistimeseries.Whenlistingtimeseries, pointsarereturnedinreversetimeorder.Whencreatinga timeseries,thisfieldmustcontainexactlyonepointandthe point’stypemustbethesameasthevaluetypeofthe associatedmetric.Iftheassociatedmetric’sdescriptormust beauto-created,thenthevaluetypeofthedescriptoris determinedbythepoint’stype,whichmustbeBOOL, INT64,DOUBLE,orDISTRIBUTION. metadata Fieldgoogle.monitoring.v3.TimeSeries.metadata metric Fieldgoogle.monitoring.v3.TimeSeries.metric metric_kind Fieldgoogle.monitoring.v3.TimeSeries.metric_kind points Fieldgoogle.monitoring.v3.TimeSeries.points resource Fieldgoogle.monitoring.v3.TimeSeries.resource value_type Fieldgoogle.monitoring.v3.TimeSeries.value_type classgoogle.cloud.monitoring_v3.types.TimeSeriesRatio¶ ATimeSeriesRatiospecifiestwoTimeSeriestouseforcomputing thegood_service/total_serviceratio.ThespecifiedTimeSeries musthaveValueType=DOUBLEorValueType=INT64andmusthave MetricKind=DELTAorMetricKind=CUMULATIVE.The TimeSeriesRatiomustspecifyexactlytwoofgood,bad,andtotal, andtherelationshipgood_service+bad_service=total_servicewill beassumed. good_service_filter¶ Amonitoringfilter specifyingaTimeSeriesquantifyinggoodserviceprovided. MusthaveValueType=DOUBLEorValueType=INT64and musthaveMetricKind=DELTAorMetricKind= CUMULATIVE. bad_service_filter¶ Amonitoringfilter specifyingaTimeSeriesquantifyingbadservice,either demandedservicethatwasnotprovidedordemandedservice thatwasofinadequatequality.MusthaveValueType= DOUBLEorValueType=INT64andmusthaveMetricKind= DELTAorMetricKind=CUMULATIVE. total_service_filter¶ Amonitoringfilter specifyingaTimeSeriesquantifyingtotaldemanded service.MusthaveValueType=DOUBLEorValueType= INT64andmusthaveMetricKind=DELTAorMetricKind= CUMULATIVE. bad_service_filter Fieldgoogle.monitoring.v3.TimeSeriesRatio.bad_service_filter good_service_filter Fieldgoogle.monitoring.v3.TimeSeriesRatio.good_service_filter total_service_filter Fieldgoogle.monitoring.v3.TimeSeriesRatio.total_service_filter classgoogle.cloud.monitoring_v3.types.Timestamp¶ nanos¶ Fieldgoogle.protobuf.Timestamp.nanos seconds¶ Fieldgoogle.protobuf.Timestamp.seconds classgoogle.cloud.monitoring_v3.types.TypedValue¶ Asinglestrongly-typedvalue. value¶ Thetypedvaluefield. bool_value¶ ABooleanvalue:trueorfalse. int64_value¶ A64-bitinteger.Itsrangeisapproximately±9.2x1018. double_value¶ A64-bitdouble-precisionfloating-pointnumber.Itsmagnitude isapproximately±10±300andithas16significantdigitsof precision. string_value¶ Avariable-lengthstringvalue. distribution_value¶ Adistributionvalue. bool_value Fieldgoogle.monitoring.v3.TypedValue.bool_value distribution_value Fieldgoogle.monitoring.v3.TypedValue.distribution_value double_value Fieldgoogle.monitoring.v3.TypedValue.double_value int64_value Fieldgoogle.monitoring.v3.TypedValue.int64_value string_value Fieldgoogle.monitoring.v3.TypedValue.string_value classgoogle.cloud.monitoring_v3.types.UInt32Value¶ value¶ Fieldgoogle.protobuf.UInt32Value.value classgoogle.cloud.monitoring_v3.types.UInt64Value¶ value¶ Fieldgoogle.protobuf.UInt64Value.value classgoogle.cloud.monitoring_v3.types.UpdateAlertPolicyRequest¶ TheprotocolfortheUpdateAlertPolicyrequest. update_mask¶ Optional.Alistofalertingpolicyfieldnames.Ifthisfield isnotempty,eachlistedfieldintheexistingalerting policyissettothevalueofthecorrespondingfieldinthe suppliedpolicy(alert_policy),ortothefield’sdefault valueifthefieldisnotinthesuppliedalertingpolicy. Fieldsnotlistedretaintheirpreviousvalue.Examplesof validfieldmasksincludedisplay_name,documentation, documentation.content,documentation.mime_type, user_labels,user_label.nameofkey,enabled, conditions,combiner,etc.Ifthisfieldisempty, thenthesuppliedalertingpolicyreplacestheexisting policy.Itisthesameasdeletingtheexistingpolicyand addingthesuppliedpolicy,exceptforthefollowing:-The newpolicywillhavethesame[ALERT_POLICY_ID]asthe formerpolicy.Thisgivesyoucontinuitywiththeformer policyinyournotificationsandincidents.-Conditions inthenewpolicywillkeeptheirformer[CONDITION_ID] ifthesuppliedconditionincludesthenamefieldwith that[CONDITION_ID].Ifthesuppliedconditionomits thenamefield,thenanew[CONDITION_ID]iscreated. alert_policy¶ Required.Theupdatedalertingpolicyortheupdatedvalues forthefieldslistedinupdate_mask.Ifupdate_mask isnotempty,anyfieldsinthispolicythatarenotin update_maskareignored. alert_policy Fieldgoogle.monitoring.v3.UpdateAlertPolicyRequest.alert_policy update_mask Fieldgoogle.monitoring.v3.UpdateAlertPolicyRequest.update_mask classgoogle.cloud.monitoring_v3.types.UpdateGroupRequest¶ TheUpdateGrouprequest. group¶ Thenewdefinitionofthegroup.Allfieldsoftheexisting group,exceptingname,arereplacedwiththecorresponding fieldsofthisgroup. validate_only¶ Iftrue,validatethisrequestbutdonotupdatetheexisting group. group Fieldgoogle.monitoring.v3.UpdateGroupRequest.group validate_only Fieldgoogle.monitoring.v3.UpdateGroupRequest.validate_only classgoogle.cloud.monitoring_v3.types.UpdateNotificationChannelRequest¶ TheUpdateNotificationChannelrequest. update_mask¶ Thefieldstoupdate. notification_channel¶ Adescriptionofthechangestobeappliedtothespecified notificationchannel.Thedescriptionmustprovidea definitionforfieldstobeupdated;thenamesofthesefields shouldalsobeincludedintheupdate_mask. notification_channel Fieldgoogle.monitoring.v3.UpdateNotificationChannelRequest.notification_channel update_mask Fieldgoogle.monitoring.v3.UpdateNotificationChannelRequest.update_mask classgoogle.cloud.monitoring_v3.types.UpdateServiceLevelObjectiveRequest¶ TheUpdateServiceLevelObjectiverequest. service_level_objective¶ TheServiceLevelObjectivetodrawupdatesfrom.Thegiven namespecifiestheresourcetoupdate. update_mask¶ Asetoffieldpathsdefiningwhichfieldstouseforthe update. service_level_objective Fieldgoogle.monitoring.v3.UpdateServiceLevelObjectiveRequest.service_level_objective update_mask Fieldgoogle.monitoring.v3.UpdateServiceLevelObjectiveRequest.update_mask classgoogle.cloud.monitoring_v3.types.UpdateServiceRequest¶ TheUpdateServicerequest. service¶ TheServicetodrawupdatesfrom.Thegivenname specifiestheresourcetoupdate. update_mask¶ Asetoffieldpathsdefiningwhichfieldstouseforthe update. service Fieldgoogle.monitoring.v3.UpdateServiceRequest.service update_mask Fieldgoogle.monitoring.v3.UpdateServiceRequest.update_mask classgoogle.cloud.monitoring_v3.types.UpdateUptimeCheckConfigRequest¶ TheprotocolfortheUpdateUptimeCheckConfigrequest. update_mask¶ Optional.Ifpresent,onlythelistedfieldsinthecurrent Uptimecheckconfigurationareupdatedwithvaluesfromthe newconfiguration.Ifthisfieldisempty,thenthecurrent configurationiscompletelyreplacedwiththenew configuration. uptime_check_config¶ Required.IfanupdateMaskhasbeenspecified,thisfield givesthevaluesforthesetoffieldsmentionedinthe updateMask.IfanupdateMaskhasnotbeengiven,this Uptimecheckconfigurationreplacesthecurrentconfiguration. IfafieldismentionedinupdateMaskbutthecorresonding fieldisomittedinthispartialUptimecheckconfiguration, ithastheeffectofdeleting/clearingthefieldfromthe configurationontheserver.Thefollowingfieldscanbe updated:display_name,http_check,tcp_check, timeout,content_matchers,andselected_regions. update_mask Fieldgoogle.monitoring.v3.UpdateUptimeCheckConfigRequest.update_mask uptime_check_config Fieldgoogle.monitoring.v3.UpdateUptimeCheckConfigRequest.uptime_check_config classgoogle.cloud.monitoring_v3.types.UptimeCheckConfig¶ Thismessageconfigureswhichresourcesandservicestomonitorfor availability. name¶ AuniqueresourcenameforthisUptimecheckconfiguration. Theformatis:projects/[PROJECT_ID]/uptimeCheckConfigs/[UP TIME_CHECK_ID].Thisfieldshouldbeomittedwhencreating theUptimecheckconfiguration;oncreate,theresourcename isassignedbytheserverandincludedintheresponse. display_name¶ Ahuman-friendlynamefortheUptimecheckconfiguration.The displaynameshouldbeuniquewithinaStackdriverWorkspace inordertomakeiteasiertoidentify;however,uniquenessis notenforced.Required. resource¶ Theresourcethecheckischecking.Required. monitored_resource¶ Themonitoredresource associatedwiththeconfiguration.Thefollowingmonitored resourcetypesaresupportedforUptimechecks: uptime_url,gce_instance,gae_app, aws_ec2_instance,aws_elb_load_balancer resource_group¶ Thegroupresourceassociatedwiththeconfiguration. check_request_type¶ ThetypeofUptimecheckrequest. http_check¶ ContainsinformationneededtomakeanHTTPorHTTPScheck. tcp_check¶ ContainsinformationneededtomakeaTCPcheck. period¶ Howoften,inseconds,theUptimecheckisperformed. Currently,theonlysupportedvaluesare60s(1minute), 300s(5minutes),600s(10minutes),and900s(15 minutes).Optional,defaultsto60s. timeout¶ Themaximumamountoftimetowaitfortherequesttocomplete (mustbebetween1and60seconds).Required. content_matchers¶ Thecontentthatisexpectedtoappearinthedatareturnedby thetargetserveragainstwhichthecheckisrun.Currently, onlythefirstentryinthecontent_matcherslistis supported,andadditionalentrieswillbeignored.Thisfield isoptionalandshouldonlybespecifiedifacontentmatchis requiredaspartofthe/Uptimecheck. selected_regions¶ Thelistofregionsfromwhichthecheckwillberun.Some regionscontainonelocation,andotherscontainmorethan one.Ifthisfieldisspecified,enoughregionsmustbe providedtoincludeaminimumof3locations.Notspecifying thisfieldwillresultinUptimechecksrunningfromall availableregions. is_internal¶ Ifthisistrue,thenchecksaremadeonlyfromthe ‘internal_checkers’.Ifitisfalse,thenchecksaremade onlyfromthe‘selected_regions’.Itisanerrortoprovide ‘selected_regions’whenis_internalistrue,orto provide‘internal_checkers’whenis_internalisfalse. internal_checkers¶ Theinternalcheckersthatthischeckwillegressfrom.If is_internalistrueandthislistisempty,thecheck willegressfromalltheInternalCheckersconfiguredforthe projectthatownsthisUptimeCheckConfig. classContentMatcher¶ Optional.Usedtoperformcontentmatching.Thisallowsmatchingbased onsubstringsandregularexpressions,togetherwiththeirnegations. Onlythefirst4 MBofanHTTPorHTTPScheck’sresponse(andthefirst 1 MBofaTCPcheck’sresponse)areexaminedforpurposesofcontent matching. content¶ Stringorregexcontenttomatch.Maximum1024bytes.Anempty contentstringindicatesnocontentmatchingistobe performed. matcher¶ Thetypeofcontentmatcherthatwillbeappliedtotheserver output,comparedtothecontentstringwhenthecheckis run. content Fieldgoogle.monitoring.v3.UptimeCheckConfig.ContentMatcher.content matcher Fieldgoogle.monitoring.v3.UptimeCheckConfig.ContentMatcher.matcher classHttpCheck¶ InformationinvolvedinanHTTP/HTTPSUptimecheckrequest. use_ssl¶ Iftrue,useHTTPSinsteadofHTTPtorunthecheck. path¶ Optional(defaultsto“/”).Thepathtothepageagainstwhich torunthecheck.Willbecombinedwiththehost (specifiedwithinthemonitored_resource)andportto constructthefullURL.Iftheprovidedpathdoesnotbegin with“/”,a“/”willbeprependedautomatically. port¶ Optional(defaultsto80whenuse_sslisfalse,and 443whenuse_sslistrue).TheTCPportontheHTTP serveragainstwhichtorunthecheck.Willbecombinedwith host(specifiedwithinthemonitored_resource)and pathtoconstructthefullURL. auth_info¶ Theauthenticationinformation.OptionalwhencreatinganHTTP check;defaultstoempty. mask_headers¶ Booleanspecifiyingwhethertoencrypttheheaderinformation. Encryptionshouldbespecifiedforanyheadersrelatedto authenticationthatyoudonotwishtobeseenwhenretrieving theconfiguration.Theserverwillberesponsiblefor encryptingtheheaders.OnGet/Listcalls,ifmask_headers issettotruethentheheaderswillbeobscuredwith ******. headers¶ ThelistofheaderstosendaspartoftheUptimecheck request.Iftwoheadershavethesamekeyanddifferent values,theyshouldbeenteredasasingleheader,withthe valuebeingacomma-separatedlistofallthedesiredvalues asdescribedat https://www.w3.org/Protocols/rfc2616/rfc2616.txt(page31). EnteringtwoseparateheaderswiththesamekeyinaCreate callwillcausethefirsttobeoverwrittenbythesecond.The maximumnumberofheadersallowedis100. validate_ssl¶ BooleanspecifyingwhethertoincludeSSLcertificate validationasapartoftheUptimecheck.Onlyappliesto checkswheremonitored_resourceissettouptime_url. Ifuse_sslisfalse,settingvalidate_sslto truehasnoeffect. classBasicAuthentication¶ Theauthenticationparameterstoprovidetothespecifiedresourceor URLthatrequiresausernameandpassword.Currently,onlyBasicHTTP authenticationissupportedin Uptimechecks. username¶ TheusernametousewhenauthenticatingwiththeHTTPserver. password¶ ThepasswordtousewhenauthenticatingwiththeHTTPserver. password Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication.password username Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication.username classHeadersEntry¶ key¶ Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.HeadersEntry.key value¶ Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.HeadersEntry.value auth_info Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.auth_info headers Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.headers mask_headers Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.mask_headers path Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.path port Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.port use_ssl Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.use_ssl validate_ssl Fieldgoogle.monitoring.v3.UptimeCheckConfig.HttpCheck.validate_ssl classResourceGroup¶ Theresourcesubmessageforgroupchecks.Itcanbeusedinsteadofa monitoredresource,whenmultipleresourcesarebeingmonitored. group_id¶ Thegroupofresourcesbeingmonitored.Shouldbeonlythe [GROUP_ID],andnotthefull-path projects/[PROJECT_ID]/groups/[GROUP_ID]. resource_type¶ Theresourcetypeofthegroupmembers. group_id Fieldgoogle.monitoring.v3.UptimeCheckConfig.ResourceGroup.group_id resource_type Fieldgoogle.monitoring.v3.UptimeCheckConfig.ResourceGroup.resource_type classTcpCheck¶ InformationrequiredforaTCPUptimecheckrequest. port¶ TheTCPportontheserveragainstwhichtorunthecheck. Willbecombinedwithhost(specifiedwithinthe monitored_resource)toconstructthefullURL.Required. port Fieldgoogle.monitoring.v3.UptimeCheckConfig.TcpCheck.port content_matchers Fieldgoogle.monitoring.v3.UptimeCheckConfig.content_matchers display_name Fieldgoogle.monitoring.v3.UptimeCheckConfig.display_name http_check Fieldgoogle.monitoring.v3.UptimeCheckConfig.http_check internal_checkers Fieldgoogle.monitoring.v3.UptimeCheckConfig.internal_checkers is_internal Fieldgoogle.monitoring.v3.UptimeCheckConfig.is_internal monitored_resource Fieldgoogle.monitoring.v3.UptimeCheckConfig.monitored_resource name Fieldgoogle.monitoring.v3.UptimeCheckConfig.name period Fieldgoogle.monitoring.v3.UptimeCheckConfig.period resource_group Fieldgoogle.monitoring.v3.UptimeCheckConfig.resource_group selected_regions Fieldgoogle.monitoring.v3.UptimeCheckConfig.selected_regions tcp_check Fieldgoogle.monitoring.v3.UptimeCheckConfig.tcp_check timeout Fieldgoogle.monitoring.v3.UptimeCheckConfig.timeout classgoogle.cloud.monitoring_v3.types.UptimeCheckIp¶ Containstheregion,location,andlistofIPaddresseswherecheckers inthelocationrunfrom. region¶ AbroadregioncategoryinwhichtheIPaddressislocated. location¶ Amorespecificlocationwithintheregionthattypically encodesaparticularcity/town/metro(anditscontaining state/provinceorcountry)withinthebroaderumbrellaregion category. ip_address¶ TheIPaddressfromwhichtheUptimecheckoriginates.Thisis afullyspecifiedIPaddress(notanIPaddressrange).Most IPaddresses,asofthispublication,areinIPv4format; however,oneshouldnotrelyontheIPaddressesbeinginIPv4 formatindefinitely,andshouldsupportinterpretingthis fieldineitherIPv4orIPv6format. ip_address Fieldgoogle.monitoring.v3.UptimeCheckIp.ip_address location Fieldgoogle.monitoring.v3.UptimeCheckIp.location region Fieldgoogle.monitoring.v3.UptimeCheckIp.region classgoogle.cloud.monitoring_v3.types.Value¶ bool_value¶ Fieldgoogle.protobuf.Value.bool_value list_value¶ Fieldgoogle.protobuf.Value.list_value null_value¶ Fieldgoogle.protobuf.Value.null_value number_value¶ Fieldgoogle.protobuf.Value.number_value string_value¶ Fieldgoogle.protobuf.Value.string_value struct_value¶ Fieldgoogle.protobuf.Value.struct_value classgoogle.cloud.monitoring_v3.types.VerifyNotificationChannelRequest¶ TheVerifyNotificationChannelrequest. name¶ Thenotificationchanneltoverify. code¶ Theverificationcodethatwasdeliveredtothechannelasa resultofinvokingthe SendNotificationChannelVerificationCodeAPImethodorthat wasretrievedfromaverifiedchannelvia GetNotificationChannelVerificationCode.Forexample,one mighthave“G-123456”or“TKNZGhhd2EyN3I1MnRnMjRv”(in general,oneisonlyguaranteedthatthecodeisvalidUTF-8; oneshouldnotmakeanyassumptionsregardingthestructureor formatofthecode). code Fieldgoogle.monitoring.v3.VerifyNotificationChannelRequest.code name Fieldgoogle.monitoring.v3.VerifyNotificationChannelRequest.name classgoogle.cloud.monitoring_v3.types.WindowsBasedSli¶ AWindowsBasedSlidefinesgood_serviceasthecountoftime windowsforwhichtheprovidedservicewasofgoodquality.Criteriafor determiningifservicewasgoodareembeddedinthe window_criterion. window_criterion¶ Thecriteriontouseforevaluatingwindowgoodness. good_bad_metric_filter¶ Amonitoringfilter specifyingaTimeSerieswithValueType=BOOL.The windowisgoodifanytruevaluesappearinthewindow. good_total_ratio_threshold¶ Awindowisgoodifitsperformanceishighenough. metric_mean_in_range¶ Awindowisgoodifthemetric’svalueisinagoodrange, averagedacrossreturnedstreams. metric_sum_in_range¶ Awindowisgoodifthemetric’svalueisinagoodrange, summedacrossreturnedstreams. window_period¶ Durationoverwhichwindowqualityisevaluated.Mustbean integerfractionofadayandatleast60s. classMetricRange¶ AMetricRangeisusedwheneachwindowisgoodwhenthevaluexofa singleTimeSeriessatisfiesrange.min<=x=threshold,thewindowiscounted asgood. basic_sli_performance Fieldgoogle.monitoring.v3.WindowsBasedSli.PerformanceThreshold.basic_sli_performance performance Fieldgoogle.monitoring.v3.WindowsBasedSli.PerformanceThreshold.performance threshold Fieldgoogle.monitoring.v3.WindowsBasedSli.PerformanceThreshold.threshold good_bad_metric_filter Fieldgoogle.monitoring.v3.WindowsBasedSli.good_bad_metric_filter good_total_ratio_threshold Fieldgoogle.monitoring.v3.WindowsBasedSli.good_total_ratio_threshold metric_mean_in_range Fieldgoogle.monitoring.v3.WindowsBasedSli.metric_mean_in_range metric_sum_in_range Fieldgoogle.monitoring.v3.WindowsBasedSli.metric_sum_in_range window_period Fieldgoogle.monitoring.v3.WindowsBasedSli.window_period google-cloud-monitoring GoogleCloudClientLibrariesforPython Navigation TimeSeriesQuery ClientforStackdriverMonitoringAPI TypesforStackdriverMonitoringAPIClient Changelog RelatedTopics Documentationoverview Previous:ClientforStackdriverMonitoringAPI Next:Changelog Quicksearch