mirror of
https://github.com/hanzo-cpp/sdk.git
synced 2026-11-20 19:55:32 +00:00
The projection these were generated from was a month old and predated the compute migration, so every one of them described /v1/visor — which the API serves at zero paths now. That is why a hand-written console client and a generated one had drifted the same way at the same time. No /v1/visor path survives here. The word still appears as a source-plane value and inside gvisor and supervisor, which are not this rename.
4903 lines
306 KiB
C++
4903 lines
306 KiB
C++
/**
|
|
* Hanzo Cloud API
|
|
* The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
|
|
*
|
|
* The version of the OpenAPI document: v1
|
|
*
|
|
* NOTE: This class is auto generated by OpenAPI-Generator 7.14.0.
|
|
* https://openapi-generator.tech
|
|
* Do not edit the class manually.
|
|
*/
|
|
|
|
/*
|
|
* O11yApi.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_API_O11yApi_H_
|
|
#define HANZO_API_O11yApi_H_
|
|
|
|
|
|
|
|
#include "hanzo/ApiClient.h"
|
|
|
|
#include "hanzo/AnyType.h"
|
|
#include "hanzo/model/O11y_ClusterListRequest.h"
|
|
#include "hanzo/model/O11y_DaemonSetListRequest.h"
|
|
#include "hanzo/model/O11y_DeploymentListRequest.h"
|
|
#include "hanzo/model/O11y_FilterAttributeValueRequest.h"
|
|
#include "hanzo/model/O11y_HostListRequest.h"
|
|
#include "hanzo/model/O11y_InstallIntegrationRequest.h"
|
|
#include "hanzo/model/O11y_JobListRequest.h"
|
|
#include "hanzo/model/O11y_NamespaceListRequest.h"
|
|
#include "hanzo/model/O11y_NodeListRequest.h"
|
|
#include "hanzo/model/O11y_O11yAPIKeyCreateIn.h"
|
|
#include "hanzo/model/O11y_O11yAPIKeyCreateOut.h"
|
|
#include "hanzo/model/O11y_O11yAPIKeyUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yAPIKeysOut.h"
|
|
#include "hanzo/model/O11y_O11yAccountOut.h"
|
|
#include "hanzo/model/O11y_O11yAccountsOut.h"
|
|
#include "hanzo/model/O11y_O11yAck.h"
|
|
#include "hanzo/model/O11y_O11yAgentCheckInIn.h"
|
|
#include "hanzo/model/O11y_O11yAgentCheckInOut.h"
|
|
#include "hanzo/model/O11y_O11yAggregateAttributesOut.h"
|
|
#include "hanzo/model/O11y_O11yAlertsOut.h"
|
|
#include "hanzo/model/O11y_O11yAnalyzeIn.h"
|
|
#include "hanzo/model/O11y_O11yAnalyzeOut.h"
|
|
#include "hanzo/model/O11y_O11yApdexOut.h"
|
|
#include "hanzo/model/O11y_O11yApdexSetIn.h"
|
|
#include "hanzo/model/O11y_O11yApdexSetOut.h"
|
|
#include "hanzo/model/O11y_O11yAttributeKeysOut.h"
|
|
#include "hanzo/model/O11y_O11yAttributeValuesOut.h"
|
|
#include "hanzo/model/O11y_O11yAuthDomainOut.h"
|
|
#include "hanzo/model/O11y_O11yAuthDomainsOut.h"
|
|
#include "hanzo/model/O11y_O11yBulkInviteIn.h"
|
|
#include "hanzo/model/O11y_O11yChangePasswordIn.h"
|
|
#include "hanzo/model/O11y_O11yChannelOut.h"
|
|
#include "hanzo/model/O11y_O11yChannelUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yChannelsOut.h"
|
|
#include "hanzo/model/O11y_O11yCheckOut.h"
|
|
#include "hanzo/model/O11y_O11yClusterListOut.h"
|
|
#include "hanzo/model/O11y_O11yConnectionStatusOut.h"
|
|
#include "hanzo/model/O11y_O11yCreateAccountIn.h"
|
|
#include "hanzo/model/O11y_O11yCreateAccountOut.h"
|
|
#include "hanzo/model/O11y_O11yCreateLimitIn.h"
|
|
#include "hanzo/model/O11y_O11yCreatedIngestionKeyOut.h"
|
|
#include "hanzo/model/O11y_O11yCreatedLimitOut.h"
|
|
#include "hanzo/model/O11y_O11yCreatedOut.h"
|
|
#include "hanzo/model/O11y_O11yCredentialsOut.h"
|
|
#include "hanzo/model/O11y_O11yDaemonSetListOut.h"
|
|
#include "hanzo/model/O11y_O11yDashboardListForUserOut.h"
|
|
#include "hanzo/model/O11y_O11yDashboardListOut.h"
|
|
#include "hanzo/model/O11y_O11yDashboardOut.h"
|
|
#include "hanzo/model/O11y_O11yDashboardPatchIn.h"
|
|
#include "hanzo/model/O11y_O11yDashboardPostable.h"
|
|
#include "hanzo/model/O11y_O11yDashboardUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yDashboardVarsIn.h"
|
|
#include "hanzo/model/O11y_O11yDashboardVarsOut.h"
|
|
#include "hanzo/model/O11y_O11yDashboardViewListOut.h"
|
|
#include "hanzo/model/O11y_O11yDashboardViewOut.h"
|
|
#include "hanzo/model/O11y_O11yDashboardViewPostable.h"
|
|
#include "hanzo/model/O11y_O11yDashboardViewUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yDependency.h"
|
|
#include "hanzo/model/O11y_O11yDependencyGraphIn.h"
|
|
#include "hanzo/model/O11y_O11yDeploymentListOut.h"
|
|
#include "hanzo/model/O11y_O11yDeprecatedUserOut.h"
|
|
#include "hanzo/model/O11y_O11yDeprecatedUserUpdate.h"
|
|
#include "hanzo/model/O11y_O11yDeprecatedUsersOut.h"
|
|
#include "hanzo/model/O11y_O11yDiscoverIn.h"
|
|
#include "hanzo/model/O11y_O11yDiscoverOut.h"
|
|
#include "hanzo/model/O11y_O11yDisk.h"
|
|
#include "hanzo/model/O11y_O11yDomainsIn.h"
|
|
#include "hanzo/model/O11y_O11yDomainsOut.h"
|
|
#include "hanzo/model/O11y_O11yDowntimeScheduleOut.h"
|
|
#include "hanzo/model/O11y_O11yDowntimeSchedulesOut.h"
|
|
#include "hanzo/model/O11y_O11yDowntimeUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yDraftFunnelIn.h"
|
|
#include "hanzo/model/O11y_O11yEmailPasswordSessionIn.h"
|
|
#include "hanzo/model/O11y_O11yErrorGettableIssueOut.h"
|
|
#include "hanzo/model/O11y_O11yErrorIssueOut.h"
|
|
#include "hanzo/model/O11y_O11yErrorIssuesOut.h"
|
|
#include "hanzo/model/O11y_O11yErrorUpdateIssueIn.h"
|
|
#include "hanzo/model/O11y_O11yErrorWithSpan.h"
|
|
#include "hanzo/model/O11y_O11yErrorsCountIn.h"
|
|
#include "hanzo/model/O11y_O11yErrorsListIn.h"
|
|
#include "hanzo/model/O11y_O11yEventIn.h"
|
|
#include "hanzo/model/O11y_O11yFeaturesOut.h"
|
|
#include "hanzo/model/O11y_O11yFieldCatalogOut.h"
|
|
#include "hanzo/model/O11y_O11yFieldKeysOut.h"
|
|
#include "hanzo/model/O11y_O11yFieldSetting.h"
|
|
#include "hanzo/model/O11y_O11yFieldValuesOut.h"
|
|
#include "hanzo/model/O11y_O11yFilterSuggestionsOut.h"
|
|
#include "hanzo/model/O11y_O11yForgotPasswordIn.h"
|
|
#include "hanzo/model/O11y_O11yFunnelCreateIn.h"
|
|
#include "hanzo/model/O11y_O11yFunnelDeleteOut.h"
|
|
#include "hanzo/model/O11y_O11yFunnelOut.h"
|
|
#include "hanzo/model/O11y_O11yFunnelRowsOut.h"
|
|
#include "hanzo/model/O11y_O11yFunnelStepWindowIn.h"
|
|
#include "hanzo/model/O11y_O11yFunnelStepsUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yFunnelUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yFunnelWindowIn.h"
|
|
#include "hanzo/model/O11y_O11yFunnelsOut.h"
|
|
#include "hanzo/model/O11y_O11yGettableHostOut.h"
|
|
#include "hanzo/model/O11y_O11yGlobalConfigOut.h"
|
|
#include "hanzo/model/O11y_O11yHealthOut.h"
|
|
#include "hanzo/model/O11y_O11yHostListOut.h"
|
|
#include "hanzo/model/O11y_O11yIdentifiableOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraAttributeKeysOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraAttributeValuesOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraChecksOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraClustersOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraDaemonSetsOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraDeploymentsOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraHostsOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraJobsOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraNamespacesOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraNodesOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraPodsOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraStatefulSetsOut.h"
|
|
#include "hanzo/model/O11y_O11yInfraVolumesOut.h"
|
|
#include "hanzo/model/O11y_O11yIngestionKeysOut.h"
|
|
#include "hanzo/model/O11y_O11yInstallOut.h"
|
|
#include "hanzo/model/O11y_O11yIntegrationAck.h"
|
|
#include "hanzo/model/O11y_O11yIntegrationOut.h"
|
|
#include "hanzo/model/O11y_O11yIntegrationsListOut.h"
|
|
#include "hanzo/model/O11y_O11yInviteIn.h"
|
|
#include "hanzo/model/O11y_O11yInviteOut.h"
|
|
#include "hanzo/model/O11y_O11yJobListOut.h"
|
|
#include "hanzo/model/O11y_O11yLLMAnnotationOut.h"
|
|
#include "hanzo/model/O11y_O11yLLMAnnotationsOut.h"
|
|
#include "hanzo/model/O11y_O11yLLMIngestAnnotation.h"
|
|
#include "hanzo/model/O11y_O11yLLMIngestScore.h"
|
|
#include "hanzo/model/O11y_O11yLLMObservationsOut.h"
|
|
#include "hanzo/model/O11y_O11yLLMPricingRuleOut.h"
|
|
#include "hanzo/model/O11y_O11yLLMPricingRulesOut.h"
|
|
#include "hanzo/model/O11y_O11yLLMScoreOut.h"
|
|
#include "hanzo/model/O11y_O11yLLMScoresOut.h"
|
|
#include "hanzo/model/O11y_O11yLLMSessionsOut.h"
|
|
#include "hanzo/model/O11y_O11yLLMTracesOut.h"
|
|
#include "hanzo/model/O11y_O11yLLMUpdatablePricingRules.h"
|
|
#include "hanzo/model/O11y_O11yLLMUsersOut.h"
|
|
#include "hanzo/model/O11y_O11yLicenseActiveOut.h"
|
|
#include "hanzo/model/O11y_O11yLicensesOut.h"
|
|
#include "hanzo/model/O11y_O11yListError.h"
|
|
#include "hanzo/model/O11y_O11yLogAggregateOut.h"
|
|
#include "hanzo/model/O11y_O11yLogPipelineCreateIn.h"
|
|
#include "hanzo/model/O11y_O11yLogPipelinePreviewIn.h"
|
|
#include "hanzo/model/O11y_O11yLogPipelinePreviewOut.h"
|
|
#include "hanzo/model/O11y_O11yLogPipelinesOut.h"
|
|
#include "hanzo/model/O11y_O11yLogPromoteOut.h"
|
|
#include "hanzo/model/O11y_O11yLogPromotePath.h"
|
|
#include "hanzo/model/O11y_O11yLogPromotedOut.h"
|
|
#include "hanzo/model/O11y_O11yLogRecordsOut.h"
|
|
#include "hanzo/model/O11y_O11yLogsOut.h"
|
|
#include "hanzo/model/O11y_O11yMessage.h"
|
|
#include "hanzo/model/O11y_O11yMetricAckOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricAlertsOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricAttributesOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricDashboardsOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricHighlightsOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricInspectIn.h"
|
|
#include "hanzo/model/O11y_O11yMetricInspectOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricListOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricMetadataOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricMetadataSaveIn.h"
|
|
#include "hanzo/model/O11y_O11yMetricOnboardingOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricStatsIn.h"
|
|
#include "hanzo/model/O11y_O11yMetricStatsOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricTreemapIn.h"
|
|
#include "hanzo/model/O11y_O11yMetricTreemapOut.h"
|
|
#include "hanzo/model/O11y_O11yMetricsQueryRangeOut.h"
|
|
#include "hanzo/model/O11y_O11yMyServiceAccountUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yNamespaceListOut.h"
|
|
#include "hanzo/model/O11y_O11yNextPrevErrorIDs.h"
|
|
#include "hanzo/model/O11y_O11yNodeListOut.h"
|
|
#include "hanzo/model/O11y_O11yOnboardingOut.h"
|
|
#include "hanzo/model/O11y_O11yOperationsIn.h"
|
|
#include "hanzo/model/O11y_O11yOperationsOut.h"
|
|
#include "hanzo/model/O11y_O11yOrgStatsOut.h"
|
|
#include "hanzo/model/O11y_O11yOrganization.h"
|
|
#include "hanzo/model/O11y_O11yOrganizationOut.h"
|
|
#include "hanzo/model/O11y_O11yOverallStateTransitionsOut.h"
|
|
#include "hanzo/model/O11y_O11yPodListOut.h"
|
|
#include "hanzo/model/O11y_O11yPostableAuthDomain.h"
|
|
#include "hanzo/model/O11y_O11yPostableUser.h"
|
|
#include "hanzo/model/O11y_O11yPreferenceOut.h"
|
|
#include "hanzo/model/O11y_O11yPreferencesOut.h"
|
|
#include "hanzo/model/O11y_O11yProcessListOut.h"
|
|
#include "hanzo/model/O11y_O11yPromQueryOut.h"
|
|
#include "hanzo/model/O11y_O11yPublicDashboardDataOut.h"
|
|
#include "hanzo/model/O11y_O11yPublicDashboardOut.h"
|
|
#include "hanzo/model/O11y_O11yPublicDashboardWriteIn.h"
|
|
#include "hanzo/model/O11y_O11yPvcListOut.h"
|
|
#include "hanzo/model/O11y_O11yQueryRangeFormatOut.h"
|
|
#include "hanzo/model/O11y_O11yQueryRangeOut.h"
|
|
#include "hanzo/model/O11y_O11yQueryRangePreviewIn.h"
|
|
#include "hanzo/model/O11y_O11yQueryRangePreviewOut.h"
|
|
#include "hanzo/model/O11y_O11yQueueChecksOut.h"
|
|
#include "hanzo/model/O11y_O11yQueueIn.h"
|
|
#include "hanzo/model/O11y_O11yQueueListIn.h"
|
|
#include "hanzo/model/O11y_O11yQueueRowsOut.h"
|
|
#include "hanzo/model/O11y_O11yQuickFiltersOut.h"
|
|
#include "hanzo/model/O11y_O11yReductionRuleCreateIn.h"
|
|
#include "hanzo/model/O11y_O11yReductionRuleListOut.h"
|
|
#include "hanzo/model/O11y_O11yReductionRuleOut.h"
|
|
#include "hanzo/model/O11y_O11yReductionRulePreviewIn.h"
|
|
#include "hanzo/model/O11y_O11yReductionRulePreviewOut.h"
|
|
#include "hanzo/model/O11y_O11yReductionRuleSaveIn.h"
|
|
#include "hanzo/model/O11y_O11yReductionSeriesOut.h"
|
|
#include "hanzo/model/O11y_O11yReductionStatsOut.h"
|
|
#include "hanzo/model/O11y_O11yRegisterIn.h"
|
|
#include "hanzo/model/O11y_O11yRegisterOut.h"
|
|
#include "hanzo/model/O11y_O11yResetPasswordIn.h"
|
|
#include "hanzo/model/O11y_O11yResetTokenOut.h"
|
|
#include "hanzo/model/O11y_O11yResetTokenRef.h"
|
|
#include "hanzo/model/O11y_O11yRetentionOut.h"
|
|
#include "hanzo/model/O11y_O11yRetentionSetIn.h"
|
|
#include "hanzo/model/O11y_O11yRetentionSetOut.h"
|
|
#include "hanzo/model/O11y_O11yRoleCreateIn.h"
|
|
#include "hanzo/model/O11y_O11yRoleCreateOut.h"
|
|
#include "hanzo/model/O11y_O11yRoleOut.h"
|
|
#include "hanzo/model/O11y_O11yRoleUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yRolesOut.h"
|
|
#include "hanzo/model/O11y_O11yRotateSessionIn.h"
|
|
#include "hanzo/model/O11y_O11yRoutePoliciesOut.h"
|
|
#include "hanzo/model/O11y_O11yRoutePolicyOut.h"
|
|
#include "hanzo/model/O11y_O11yRoutePolicyUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yRuleHistoryContributorsOut.h"
|
|
#include "hanzo/model/O11y_O11yRuleHistoryFilterKeysOut.h"
|
|
#include "hanzo/model/O11y_O11yRuleHistoryFilterValuesOut.h"
|
|
#include "hanzo/model/O11y_O11yRuleHistoryOverallStatusOut.h"
|
|
#include "hanzo/model/O11y_O11yRuleHistoryQueryIn.h"
|
|
#include "hanzo/model/O11y_O11yRuleHistoryStatsOut.h"
|
|
#include "hanzo/model/O11y_O11yRuleHistoryTimelineOut.h"
|
|
#include "hanzo/model/O11y_O11yRuleOut.h"
|
|
#include "hanzo/model/O11y_O11yRuleStateContributorsOut.h"
|
|
#include "hanzo/model/O11y_O11yRuleStateTimelineOut.h"
|
|
#include "hanzo/model/O11y_O11yRuleStatsOut.h"
|
|
#include "hanzo/model/O11y_O11yRulesOut.h"
|
|
#include "hanzo/model/O11y_O11ySavedViewCreateOut.h"
|
|
#include "hanzo/model/O11y_O11ySavedViewDeleteOut.h"
|
|
#include "hanzo/model/O11y_O11ySavedViewListOut.h"
|
|
#include "hanzo/model/O11y_O11ySavedViewOut.h"
|
|
#include "hanzo/model/O11y_O11ySavedViewUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11ySentryEventOut.h"
|
|
#include "hanzo/model/O11y_O11ySentryIssueEventsOut.h"
|
|
#include "hanzo/model/O11y_O11ySentryPostableProject.h"
|
|
#include "hanzo/model/O11y_O11ySentryProjectOut.h"
|
|
#include "hanzo/model/O11y_O11ySentryProjectsOut.h"
|
|
#include "hanzo/model/O11y_O11ySentryUpdateIssueIn.h"
|
|
#include "hanzo/model/O11y_O11yServiceAccountCreateIn.h"
|
|
#include "hanzo/model/O11y_O11yServiceAccountCreateOut.h"
|
|
#include "hanzo/model/O11y_O11yServiceAccountOut.h"
|
|
#include "hanzo/model/O11y_O11yServiceAccountRoleGrantIn.h"
|
|
#include "hanzo/model/O11y_O11yServiceAccountRolesOut.h"
|
|
#include "hanzo/model/O11y_O11yServiceAccountUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11yServiceAccountsOut.h"
|
|
#include "hanzo/model/O11y_O11yServiceOut.h"
|
|
#include "hanzo/model/O11y_O11yServicesIn.h"
|
|
#include "hanzo/model/O11y_O11yServicesMetadataOut.h"
|
|
#include "hanzo/model/O11y_O11yServicesOut.h"
|
|
#include "hanzo/model/O11y_O11ySessionContextOut.h"
|
|
#include "hanzo/model/O11y_O11ySetRoleIn.h"
|
|
#include "hanzo/model/O11y_O11ySignalFiltersOut.h"
|
|
#include "hanzo/model/O11y_O11ySpanMapperCreateIn.h"
|
|
#include "hanzo/model/O11y_O11ySpanMapperGroupOut.h"
|
|
#include "hanzo/model/O11y_O11ySpanMapperGroupUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11ySpanMapperGroupsOut.h"
|
|
#include "hanzo/model/O11y_O11ySpanMapperOut.h"
|
|
#include "hanzo/model/O11y_O11ySpanMapperUpdateIn.h"
|
|
#include "hanzo/model/O11y_O11ySpanMappersOut.h"
|
|
#include "hanzo/model/O11y_O11ySpanPercentileIn.h"
|
|
#include "hanzo/model/O11y_O11ySpanPercentileOut.h"
|
|
#include "hanzo/model/O11y_O11yStatefulSetListOut.h"
|
|
#include "hanzo/model/O11y_O11yStatsOut.h"
|
|
#include "hanzo/model/O11y_O11ySubstituteVarsOut.h"
|
|
#include "hanzo/model/O11y_O11yTestNotificationOut.h"
|
|
#include "hanzo/model/O11y_O11yTestRuleOut.h"
|
|
#include "hanzo/model/O11y_O11yTokenOut.h"
|
|
#include "hanzo/model/O11y_O11yTopLevelOpsIn.h"
|
|
#include "hanzo/model/O11y_O11yTraceAggregationsIn.h"
|
|
#include "hanzo/model/O11y_O11yTraceAggregationsOut.h"
|
|
#include "hanzo/model/O11y_O11yTraceFlamegraphIn.h"
|
|
#include "hanzo/model/O11y_O11yTraceFlamegraphOut.h"
|
|
#include "hanzo/model/O11y_O11yTraceOut.h"
|
|
#include "hanzo/model/O11y_O11yTraceSpanWindow.h"
|
|
#include "hanzo/model/O11y_O11yTraceWaterfallIn.h"
|
|
#include "hanzo/model/O11y_O11yTraceWaterfallOut.h"
|
|
#include "hanzo/model/O11y_O11yTracesOut.h"
|
|
#include "hanzo/model/O11y_O11yTransaction.h"
|
|
#include "hanzo/model/O11y_O11yUpdatableAuthDomain.h"
|
|
#include "hanzo/model/O11y_O11yUpdatablePreference.h"
|
|
#include "hanzo/model/O11y_O11yUpdatableQuickFilters.h"
|
|
#include "hanzo/model/O11y_O11yUpdatableUser.h"
|
|
#include "hanzo/model/O11y_O11yUpdateAccountIn.h"
|
|
#include "hanzo/model/O11y_O11yUpdateIngestionKeyIn.h"
|
|
#include "hanzo/model/O11y_O11yUpdateLimitIn.h"
|
|
#include "hanzo/model/O11y_O11yUpdateServiceIn.h"
|
|
#include "hanzo/model/O11y_O11yUsageItem.h"
|
|
#include "hanzo/model/O11y_O11yUserUpdate.h"
|
|
#include "hanzo/model/O11y_O11yUserWithRolesOut.h"
|
|
#include "hanzo/model/O11y_O11yUsersOut.h"
|
|
#include "hanzo/model/O11y_O11yVersionOut.h"
|
|
#include "hanzo/model/O11y_O11yWidgetQueryRangeOut.h"
|
|
#include "hanzo/model/O11y_PodListRequest.h"
|
|
#include "hanzo/model/O11y_PostableChannel.h"
|
|
#include "hanzo/model/O11y_PostableClusters.h"
|
|
#include "hanzo/model/O11y_PostableDaemonSets.h"
|
|
#include "hanzo/model/O11y_PostableDeployments.h"
|
|
#include "hanzo/model/O11y_PostableHost.h"
|
|
#include "hanzo/model/O11y_PostableHosts.h"
|
|
#include "hanzo/model/O11y_PostableIngestionKey.h"
|
|
#include "hanzo/model/O11y_PostableJobs.h"
|
|
#include "hanzo/model/O11y_PostableNamespaces.h"
|
|
#include "hanzo/model/O11y_PostableNodes.h"
|
|
#include "hanzo/model/O11y_PostablePlannedMaintenance.h"
|
|
#include "hanzo/model/O11y_PostablePods.h"
|
|
#include "hanzo/model/O11y_PostableProfile.h"
|
|
#include "hanzo/model/O11y_PostableRoutePolicy.h"
|
|
#include "hanzo/model/O11y_PostableSpanMapperGroup.h"
|
|
#include "hanzo/model/O11y_PostableStatefulSets.h"
|
|
#include "hanzo/model/O11y_PostableVolumes.h"
|
|
#include "hanzo/model/O11y_ProcessListRequest.h"
|
|
#include "hanzo/model/O11y_QueryRangeParamsV3.h"
|
|
#include "hanzo/model/O11y_QueryRangeRequest.h"
|
|
#include "hanzo/model/O11y_SavedView.h"
|
|
#include "hanzo/model/O11y_StatefulSetListRequest.h"
|
|
#include "hanzo/model/O11y_StatusSummary.h"
|
|
#include "hanzo/model/O11y_UninstallIntegrationRequest.h"
|
|
#include "hanzo/model/O11y_VolumeListRequest.h"
|
|
#include "hanzo/model/O11y_addItemsIn.h"
|
|
#include "hanzo/model/O11y_alertmanagertypes_Receiver.h"
|
|
#include "hanzo/model/O11y_annItemList.h"
|
|
#include "hanzo/model/O11y_annItemView.h"
|
|
#include "hanzo/model/O11y_annItemsCreated.h"
|
|
#include "hanzo/model/O11y_annQueueDeleted.h"
|
|
#include "hanzo/model/O11y_annQueueDetailView.h"
|
|
#include "hanzo/model/O11y_annQueueList.h"
|
|
#include "hanzo/model/O11y_annQueueView.h"
|
|
#include "hanzo/model/O11y_availabilityResponse.h"
|
|
#include "hanzo/model/O11y_createQueueReq.h"
|
|
#include "hanzo/model/O11y_metricsResponse.h"
|
|
#include "hanzo/model/O11y_statusResult.h"
|
|
#include "hanzo/model/O11y_tracesOut.h"
|
|
#include "hanzo/model/O11y_updateItemIn.h"
|
|
#include "hanzo/model/O11y_updateQueueIn.h"
|
|
#include <map>
|
|
#include <vector>
|
|
#include <cpprest/details/basic_types.h>
|
|
#include <boost/optional.hpp>
|
|
|
|
namespace hanzo {
|
|
namespace api {
|
|
|
|
using namespace hanzo::model;
|
|
|
|
|
|
|
|
class O11yApi
|
|
{
|
|
public:
|
|
|
|
explicit O11yApi( std::shared_ptr<const ApiClient> apiClient );
|
|
|
|
virtual ~O11yApi();
|
|
|
|
/// <summary>
|
|
/// Is the deployed agent's check-in — the path consistent with the account surface, reporting the agent's account and telemetry state so the connection can be tracked.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Is the deployed agent's check-in — the path consistent with the account surface, reporting the agent's account and telemetry state so the connection can be tracked. Viewer gate — the agent's role is viewer.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="o11yO11yAgentCheckInIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAgentCheckInOut>> agentCheckIn(
|
|
utility::string_t cloudProvider,
|
|
std::shared_ptr<O11y_O11yAgentCheckInIn> o11yO11yAgentCheckInIn
|
|
) const;
|
|
/// <summary>
|
|
/// Is the deployed agent's check-in on its original hyphenated path, kept for backward compatibility with agents already running.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Is the deployed agent's check-in on its original hyphenated path, kept for backward compatibility with agents already running. Viewer gate — the agent's role is viewer.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="o11yO11yAgentCheckInIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAgentCheckInOut>> agentCheckInDeprecated(
|
|
utility::string_t cloudProvider,
|
|
std::shared_ptr<O11y_O11yAgentCheckInIn> o11yO11yAgentCheckInIn
|
|
) const;
|
|
/// <summary>
|
|
/// Evaluates a batch of transactions — relation plus object — for the authenticated caller and answers each with its authorization verdict, in the order they were asked.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Evaluates a batch of transactions — relation plus object — for the authenticated caller and answers each with its authorization verdict, in the order they were asked. It is the read a UI uses to decide which controls to show.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yTransaction"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yCheckOut>> authzCheck(
|
|
std::vector<std::shared_ptr<O11y_O11yTransaction>> o11yO11yTransaction
|
|
) const;
|
|
/// <summary>
|
|
/// Clones an existing v2-shape dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Clones an existing v2-shape dashboard. User and integration dashboards can be cloned; system dashboards are rejected. The clone keeps the source's display name, panels and tags, but gets a freshly generated unique internal name and is always created as an unlocked user dashboard owned by the caller. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardOut>> cloneDashboardV2(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Connects a new cloud-integration account for the given provider from its posted config and credentials, answering with the account and the artifact the agent deploys to complete the connection.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Connects a new cloud-integration account for the given provider from its posted config and credentials, answering with the account and the artifact the agent deploys to complete the connection. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="o11yO11yCreateAccountIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yCreateAccountOut>> createAccount(
|
|
utility::string_t cloudProvider,
|
|
std::shared_ptr<O11y_O11yCreateAccountIn> o11yO11yCreateAccountIn
|
|
) const;
|
|
/// <summary>
|
|
/// Claims an email domain for the org and configures how its users sign in; the answer is the new domain's id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Claims an email domain for the org and configures how its users sign in; the answer is the new domain's id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yPostableAuthDomain"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yCreatedOut>> createAuthDomain(
|
|
std::shared_ptr<O11y_O11yPostableAuthDomain> o11yO11yPostableAuthDomain
|
|
) const;
|
|
/// <summary>
|
|
/// Invites several people to the caller's org in one call, refusing the whole batch when any email repeats.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Invites several people to the caller's org in one call, refusing the whole batch when any email repeats. Deprecated alongside createInvite. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yBulkInviteIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAck>> createBulkInvite(
|
|
std::shared_ptr<O11y_O11yBulkInviteIn> o11yO11yBulkInviteIn
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a notification channel, answering with the stored channel.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a notification channel, answering with the stored channel. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableChannel"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yChannelOut>> createChannel(
|
|
std::shared_ptr<O11y_PostableChannel> o11yPostableChannel
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a dashboard in the v2 format that follows the Perses spec and answers with the stored dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a dashboard in the v2 format that follows the Perses spec and answers with the stored dashboard. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDashboardPostable"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardOut>> createDashboardV2(
|
|
std::shared_ptr<O11y_O11yDashboardPostable> o11yO11yDashboardPostable
|
|
) const;
|
|
/// <summary>
|
|
/// Persists the calling user's dashboard-listing state (query, sort, order) as a named, reusable view shared across the org.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Persists the calling user's dashboard-listing state (query, sort, order) as a named, reusable view shared across the org. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDashboardViewPostable"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardViewOut>> createDashboardView(
|
|
std::shared_ptr<O11y_O11yDashboardViewPostable> o11yO11yDashboardViewPostable
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a planned maintenance window, answering with the stored schedule.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a planned maintenance window, answering with the stored schedule. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="o11yPostablePlannedMaintenance"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDowntimeScheduleOut>> createDowntimeSchedule(
|
|
std::shared_ptr<O11y_PostablePlannedMaintenance> o11yPostablePlannedMaintenance
|
|
) const;
|
|
/// <summary>
|
|
/// Mints an ingestion key for the workspace, answering with the created key.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Mints an ingestion key for the workspace, answering with the created key. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableIngestionKey"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yCreatedIngestionKeyOut>> createIngestionKey(
|
|
std::shared_ptr<O11y_PostableIngestionKey> o11yPostableIngestionKey
|
|
) const;
|
|
/// <summary>
|
|
/// Sets a signal limit on an ingestion key, by key id, answering with the created limit.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Sets a signal limit on an ingestion key, by key id, answering with the created limit. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="keyId"></param>
|
|
/// <param name="o11yO11yCreateLimitIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yCreatedLimitOut>> createIngestionKeyLimit(
|
|
utility::string_t keyId,
|
|
std::shared_ptr<O11y_O11yCreateLimitIn> o11yO11yCreateLimitIn
|
|
) const;
|
|
/// <summary>
|
|
/// Invites one person to the caller's org by email, with the role they will hold when they accept.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Invites one person to the caller's org by email, with the role they will hold when they accept. Deprecated in favor of creating users directly; kept because callers still hold it. Admin gate, enforced by the runtime this op relays to.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yInviteIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInviteOut>> createInvite(
|
|
std::shared_ptr<O11y_O11yInviteIn> o11yO11yInviteIn
|
|
) const;
|
|
/// <summary>
|
|
/// Adds a human annotation to a trace or observation, optionally in a review queue.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Adds a human annotation to a trace or observation, optionally in a review queue. Callers need the editor role; the runtime's own gate enforces it, and it validates the payload and stamps the annotation's author and org.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yLLMIngestAnnotation"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMAnnotationOut>> createLLMAnnotation(
|
|
std::shared_ptr<O11y_O11yLLMIngestAnnotation> o11yO11yLLMIngestAnnotation
|
|
) const;
|
|
/// <summary>
|
|
/// Attaches an eval score or human-feedback signal to a trace or a single observation.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Attaches an eval score or human-feedback signal to a trace or a single observation. Callers need the editor role; the runtime's own gate enforces it, and it validates the payload and stamps the score's author and org.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yLLMIngestScore"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMScoreOut>> createLLMScore(
|
|
std::shared_ptr<O11y_O11yLLMIngestScore> o11yO11yLLMIngestScore
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a volume-control rule for a metric and returns it with its id; a metric that already has a rule is refused.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a volume-control rule for a metric and returns it with its id; a metric that already has a rule is refused.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yReductionRuleCreateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yReductionRuleOut>> createMetricReductionRule(
|
|
std::shared_ptr<O11y_O11yReductionRuleCreateIn> o11yO11yReductionRuleCreateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Writes the pricing-rule batch — the single write endpoint used by both the user and the Zeus sync job.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Writes the pricing-rule batch — the single write endpoint used by both the user and the Zeus sync job. Per-rule match is by id, then sourceId, then insert; an override row is fully preserved when the request omits isOverride, only its synced_at stamped. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yLLMUpdatablePricingRules"></param>
|
|
pplx::task<void> createOrUpdateLLMPricingRules(
|
|
std::shared_ptr<O11y_O11yLLMUpdatablePricingRules> o11yO11yLLMUpdatablePricingRules
|
|
) const;
|
|
/// <summary>
|
|
/// Creates the public-sharing config for a dashboard and enables public sharing, answering with the new share's id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates the public-sharing config for a dashboard and enables public sharing, answering with the new share's id. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the dashboard id from the path.</param>
|
|
/// <param name="o11yO11yPublicDashboardWriteIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yIdentifiableOut>> createPublicDashboard(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yPublicDashboardWriteIn> o11yO11yPublicDashboardWriteIn
|
|
) const;
|
|
/// <summary>
|
|
/// Creates or regenerates a user's reset-password token: a live token is returned as it is, an expired one is replaced.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates or regenerates a user's reset-password token: a live token is returned as it is, an expired one is replaced. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yResetTokenOut>> createResetPasswordToken(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a custom role in the caller's org from a name, an optional description and the transaction groups it grants, answering the new role's id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a custom role in the caller's org from a name, an optional description and the transaction groups it grants, answering the new role's id. Names are lowercase letters and hyphens only, and may not start with the reserved managed-role prefix; the runtime refuses anything else.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yRoleCreateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRoleCreateOut>> createRole(
|
|
std::shared_ptr<O11y_O11yRoleCreateIn> o11yO11yRoleCreateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a route policy, answering with the stored policy.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a route policy, answering with the stored policy. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableRoutePolicy"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRoutePolicyOut>> createRoutePolicy(
|
|
std::shared_ptr<O11y_PostableRoutePolicy> o11yPostableRoutePolicy
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a new alert rule and answers with the stored rule.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a new alert rule and answers with the stored rule. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="body"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleOut>> createRule(
|
|
std::shared_ptr<AnyType> body
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a service account in the caller's org, answering its id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a service account in the caller's org, answering its id. The name — a lowercase letter followed by lowercase letters, digits or hyphens — becomes the account's email local part.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yServiceAccountCreateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yServiceAccountCreateOut>> createServiceAccount(
|
|
std::shared_ptr<O11y_O11yServiceAccountCreateIn> o11yO11yServiceAccountCreateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Mints an API key for a service account and answers the key's id and its secret — the one time the secret is ever shown.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Mints an API key for a service account and answers the key's id and its secret — the one time the secret is ever shown. ExpiresAt is a unix timestamp in seconds; zero means the key never expires, and a timestamp in the past is refused.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yAPIKeyCreateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAPIKeyCreateOut>> createServiceAccountKey(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yAPIKeyCreateIn> o11yO11yAPIKeyCreateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Assigns a role, named by its id, to a service account.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Assigns a role, named by its id, to a service account.
|
|
/// </remarks>
|
|
/// <param name="id">RoleID is the id of the role to assign. Required.</param>
|
|
/// <param name="o11yO11yServiceAccountRoleGrantIn"></param>
|
|
pplx::task<void> createServiceAccountRole(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yServiceAccountRoleGrantIn> o11yO11yServiceAccountRoleGrantIn
|
|
) const;
|
|
/// <summary>
|
|
/// Signs a user in with email and password and answers with the session's token pair.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Signs a user in with email and password and answers with the session's token pair. Unauthenticated: this call is how authentication begins.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yEmailPasswordSessionIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yTokenOut>> createSessionByEmailPassword(
|
|
std::shared_ptr<O11y_O11yEmailPasswordSessionIn> o11yO11yEmailPasswordSessionIn
|
|
) const;
|
|
/// <summary>
|
|
/// Adds a mapper to a group: which field context it reads, the move or copy it performs, and whether it is on.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Adds a mapper to a group: which field context it reads, the move or copy it performs, and whether it is on. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="groupId"></param>
|
|
/// <param name="o11yO11ySpanMapperCreateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySpanMapperOut>> createSpanMapper(
|
|
utility::string_t groupId,
|
|
std::shared_ptr<O11y_O11ySpanMapperCreateIn> o11yO11ySpanMapperCreateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a mapping group: the name it is known by, the span and resource attributes whose presence selects a span into it, and whether it is on.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a mapping group: the name it is known by, the span and resource attributes whose presence selects a span into it, and whether it is on. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableSpanMapperGroup"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySpanMapperGroupOut>> createSpanMapperGroup(
|
|
std::shared_ptr<O11y_PostableSpanMapperGroup> o11yPostableSpanMapperGroup
|
|
) const;
|
|
/// <summary>
|
|
/// Creates an empty funnel with a name, answering the funnel it created.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates an empty funnel with a name, answering the funnel it created. Steps are added afterwards with the steps update. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yFunnelCreateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelOut>> createTraceFunnel(
|
|
std::shared_ptr<O11y_O11yFunnelCreateIn> o11yO11yFunnelCreateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a member of the caller's org in the pending-invite state and mails them their invitation; the answer is the new user's id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a member of the caller's org in the pending-invite state and mails them their invitation; the answer is the new user's id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yPostableUser"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yCreatedOut>> createUser(
|
|
std::shared_ptr<O11y_O11yPostableUser> o11yO11yPostableUser
|
|
) const;
|
|
/// <summary>
|
|
/// Releases an email domain and discards its SSO configuration, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Releases an email domain and discards its SSO configuration, by id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteAuthDomain(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Removes a notification channel, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes a notification channel, by id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteChannelByID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Deletes a v2-shape dashboard along with its tag relations.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Deletes a v2-shape dashboard along with its tag relations. Locked dashboards are rejected. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<void> deleteDashboardV2(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Removes a saved view.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes a saved view. Saved views are shared org-wide. Deleting a non-existent view refuses with the runtime's not-found. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<void> deleteDashboardView(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Removes a planned maintenance window, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes a planned maintenance window, by id. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteDowntimeScheduleByID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Removes an ingestion key, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes an ingestion key, by id. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="keyId"></param>
|
|
pplx::task<void> deleteIngestionKey(
|
|
utility::string_t keyId
|
|
) const;
|
|
/// <summary>
|
|
/// Removes an ingestion key limit, by limit id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes an ingestion key limit, by limit id. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="limitId"></param>
|
|
pplx::task<void> deleteIngestionKeyLimit(
|
|
utility::string_t limitId
|
|
) const;
|
|
/// <summary>
|
|
/// Hard-deletes a pricing rule by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Hard-deletes a pricing rule by id. If the rule was auto-synced, the next sync cycle recreates it. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteLLMPricingRule(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Hard-deletes a score by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Hard-deletes a score by id. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteLLMScore(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Deletes a volume-control rule by its id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Deletes a volume-control rule by its id.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the rule's id.</param>
|
|
pplx::task<void> deleteMetricReductionRuleByID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Deletes one saved explorer view by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Deletes one saved explorer view by id. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="viewId">ViewID is the view's id.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySavedViewDeleteOut>> deleteO11yExplorerViewsByViewid(
|
|
utility::string_t viewId
|
|
) const;
|
|
/// <summary>
|
|
/// Removes one review queue and every item in it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes one review queue and every item in it. A queue id belonging to another org answers the same 404 an unknown id does, so a probe learns nothing about what exists.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the annotation queue to act on, from the path.</param>
|
|
pplx::task<std::shared_ptr<O11y_annQueueDeleted>> deleteO11yReviewsById(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Deletes one Sentry project of the caller's org.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Deletes one Sentry project of the caller's org. Its DSN stops resolving immediately, so ingest for that id fails closed exactly as an unknown project does; retained events are not touched. Answers 204. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the project id.</param>
|
|
pplx::task<void> deleteO11ySentinelProjectsById(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Deletes the public-sharing config and disables public sharing of a dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Deletes the public-sharing config and disables public sharing of a dashboard. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<void> deletePublicDashboard(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Deletes a custom role.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Deletes a custom role. A role that still has user or service-account assignees, or an auth-domain mapping, is refused; managed roles cannot be deleted.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteRole(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Removes a route policy, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes a route policy, by id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteRoutePolicyByID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Removes an alert rule, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes an alert rule, by id. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteRuleByID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Deletes a service account and revokes every key it holds.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Deletes a service account and revokes every key it holds.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteServiceAccount(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Removes a role from a service account.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes a role from a service account.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="rid"></param>
|
|
pplx::task<void> deleteServiceAccountRole(
|
|
utility::string_t id,
|
|
utility::string_t rid
|
|
) const;
|
|
/// <summary>
|
|
/// Signs the calling session out, invalidating its tokens.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Signs the calling session out, invalidating its tokens. The access token on the call names the session to end.
|
|
/// </remarks>
|
|
pplx::task<void> deleteSession(
|
|
) const;
|
|
/// <summary>
|
|
/// Deletes one mapper from a group.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Deletes one mapper from a group. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="groupId"></param>
|
|
/// <param name="mapperId"></param>
|
|
pplx::task<void> deleteSpanMapper(
|
|
utility::string_t groupId,
|
|
utility::string_t mapperId
|
|
) const;
|
|
/// <summary>
|
|
/// Deletes a mapping group and every mapper under it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Deletes a mapping group and every mapper under it. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="groupId"></param>
|
|
pplx::task<void> deleteSpanMapperGroup(
|
|
utility::string_t groupId
|
|
) const;
|
|
/// <summary>
|
|
/// Deletes a funnel.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Deletes a funnel. The answer carries no data — the runtime acknowledges with the success envelope alone, which is what this Out says. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="funnelId"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelDeleteOut>> deleteTraceFunnel(
|
|
utility::string_t funnelId
|
|
) const;
|
|
/// <summary>
|
|
/// Removes one org member, by user id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes one org member, by user id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteUser(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Removes one org member, by user id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes one org member, by user id. The same operation as deleteUser on the legacy singular path. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> deleteUserDeprecated(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Tears down a connected account for the given provider, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Tears down a connected account for the given provider, by id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="id"></param>
|
|
pplx::task<void> disconnectAccount(
|
|
utility::string_t cloudProvider,
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Starts the forgotten-password flow: the named user is mailed a reset link.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Starts the forgotten-password flow: the named user is mailed a reset link. Unauthenticated by design, and deliberately quiet about whether the address exists.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yForgotPasswordIn"></param>
|
|
pplx::task<void> forgotPassword(
|
|
std::shared_ptr<O11y_O11yForgotPasswordIn> o11yO11yForgotPasswordIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one connected account for the given provider, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one connected account for the given provider, by id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAccountOut>> getAccount(
|
|
utility::string_t cloudProvider,
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one service and its configuration for a connected account of the given provider, by account id and service id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one service and its configuration for a connected account of the given provider, by account id and service id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="id"></param>
|
|
/// <param name="serviceId"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yServiceOut>> getAccountService(
|
|
utility::string_t cloudProvider,
|
|
utility::string_t id,
|
|
utility::string_t serviceId
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the org's current alerts.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the org's current alerts. Viewer gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yAlertsOut>> getAlerts(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the org's route policies.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the org's route policies. Viewer gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yRoutePoliciesOut>> getAllRoutePolicies(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one auth domain with its SSO configuration, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one auth domain with its SSO configuration, by id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAuthDomainOut>> getAuthDomain(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one notification channel, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one notification channel, by id. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yChannelOut>> getChannelByID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the credentials the connecting agent needs to establish the cloud integration, for the given cloud provider.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the credentials the connecting agent needs to establish the cloud integration, for the given cloud provider. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yCredentialsOut>> getConnectionCredentials(
|
|
utility::string_t cloudProvider
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a v2-shape dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a v2-shape dashboard. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardOut>> getDashboardV2(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one planned maintenance window, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one planned maintenance window, by id. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDowntimeScheduleOut>> getDowntimeScheduleByID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the errored traces through a step transition of a funnel described inline.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the errored traces through a step transition of a funnel described inline.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDraftFunnelIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> getDraftFunnelErrorTraces(
|
|
std::shared_ptr<O11y_O11yDraftFunnelIn> o11yO11yDraftFunnelIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the conversion overview of a funnel described inline.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the conversion overview of a funnel described inline.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDraftFunnelIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> getDraftFunnelOverview(
|
|
std::shared_ptr<O11y_O11yDraftFunnelIn> o11yO11yDraftFunnelIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the slowest traces through a step transition of a funnel described inline.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the slowest traces through a step transition of a funnel described inline.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDraftFunnelIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> getDraftFunnelSlowTraces(
|
|
std::shared_ptr<O11y_O11yDraftFunnelIn> o11yO11yDraftFunnelIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the per-step metrics of a funnel described inline.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the per-step metrics of a funnel described inline.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDraftFunnelIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> getDraftFunnelStepMetrics(
|
|
std::shared_ptr<O11y_O11yDraftFunnelIn> o11yO11yDraftFunnelIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the conversion between two steps of a funnel described inline.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the conversion between two steps of a funnel described inline.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDraftFunnelIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> getDraftFunnelStepOverview(
|
|
std::shared_ptr<O11y_O11yDraftFunnelIn> o11yO11yDraftFunnelIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a trace's flamegraph: spans bucketed by depth level, each level ordered as it is drawn, around the selected span.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a trace's flamegraph: spans bucketed by depth level, each level ordered as it is drawn, around the selected span. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="traceId"></param>
|
|
/// <param name="o11yO11yTraceFlamegraphIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yTraceFlamegraphOut>> getFlamegraph(
|
|
utility::string_t traceId,
|
|
std::shared_ptr<O11y_O11yTraceFlamegraphIn> o11yO11yTraceFlamegraphIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the deployment's host info from Zeus.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the deployment's host info from Zeus. Viewer gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yGettableHostOut>> getHosts(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the workspace's ingestion keys, paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the workspace's ingestion keys, paginated. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="page">Page is the 1-based page number. (optional, default to 0L)</param>
|
|
/// <param name="perPage">PerPage is the page size. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yIngestionKeysOut>> getIngestionKeys(
|
|
boost::optional<int64_t> page,
|
|
boost::optional<int64_t> perPage
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one integration's full detail — its overview, configuration steps, collected data and assets — together with its installation record when the org has installed it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one integration's full detail — its overview, configuration steps, collected data and assets — together with its installation record when the org has installed it. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="integrationId"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yIntegrationOut>> getIntegration(
|
|
utility::string_t integrationId
|
|
) const;
|
|
/// <summary>
|
|
/// Reports whether the integration's logs and metrics have been received over the lookback window, so the console can show a live connection state.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports whether the integration's logs and metrics have been received over the lookback window, so the console can show a live connection state. An integration that is not installed answers with an empty status rather than an error. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="integrationId"></param>
|
|
/// <param name="lookbackSeconds">LookbackSeconds is how far back to look for received telemetry, in seconds. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yConnectionStatusOut>> getIntegrationConnectionStatus(
|
|
utility::string_t integrationId,
|
|
boost::optional<int64_t> lookbackSeconds
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a single LLM pricing rule by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a single LLM pricing rule by id. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMPricingRuleOut>> getLLMPricingRule(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a single score by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a single score by id. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMScoreOut>> getLLMScore(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the alert rules that reference a metric.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the alert rules that reference a metric.
|
|
/// </remarks>
|
|
/// <param name="metricName">MetricName is the metric's name; it may contain slashes, e.g. run.googleapis.com/request_latencies. Required.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricAlertsOut>> getMetricAlerts(
|
|
utility::string_t metricName
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one metric's attribute keys, each with its unique values and their count.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one metric's attribute keys, each with its unique values and their count.
|
|
/// </remarks>
|
|
/// <param name="metricName">MetricName is the metric's name; it may contain slashes. Required.</param>
|
|
/// <param name="start">Start is the start of the window as a Unix timestamp in milliseconds. (optional, default to 0L)</param>
|
|
/// <param name="end">End is the end of the window as a Unix timestamp in milliseconds. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricAttributesOut>> getMetricAttributes(
|
|
utility::string_t metricName,
|
|
boost::optional<int64_t> start,
|
|
boost::optional<int64_t> end
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the dashboard panels that reference a metric.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the dashboard panels that reference a metric.
|
|
/// </remarks>
|
|
/// <param name="metricName">MetricName is the metric's name; it may contain slashes, e.g. run.googleapis.com/request_latencies. Required.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricDashboardsOut>> getMetricDashboardsV2(
|
|
utility::string_t metricName
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one metric's headline numbers: data points, total and active time series, and when it was last received.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one metric's headline numbers: data points, total and active time series, and when it was last received.
|
|
/// </remarks>
|
|
/// <param name="metricName">MetricName is the metric's name; it may contain slashes, e.g. run.googleapis.com/request_latencies. Required.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricHighlightsOut>> getMetricHighlights(
|
|
utility::string_t metricName
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one metric's metadata: description, type, unit, temporality and monotonicity.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one metric's metadata: description, type, unit, temporality and monotonicity.
|
|
/// </remarks>
|
|
/// <param name="metricName">MetricName is the metric's name; it may contain slashes, e.g. run.googleapis.com/request_latencies. Required.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricMetadataOut>> getMetricMetadata(
|
|
utility::string_t metricName
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one volume-control rule by its id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one volume-control rule by its id.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the rule's id.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yReductionRuleOut>> getMetricReductionRuleByID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns total ingested vs retained series and samples and the estimated monthly savings across all volume-control rules.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns total ingested vs retained series and samples and the estimated monthly savings across all volume-control rules.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yReductionStatsOut>> getMetricReductionRuleStats(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns ingested vs retained series over time across all volume-control rules, in hourly buckets, in the query-range time-series response shape.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns ingested vs retained series over time across all volume-control rules, in hourly buckets, in the query-range time-series response shape.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yReductionSeriesOut>> getMetricReductionRuleTimeseries(
|
|
) const;
|
|
/// <summary>
|
|
/// Reports whether any non-O11y metrics have been ingested — the lightweight check onboarding polls.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports whether any non-O11y metrics have been ingested — the lightweight check onboarding polls.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricOnboardingOut>> getMetricsOnboardingStatus(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists metrics with their sample and time-series counts for a time range — the volume view of the metrics explorer, pageable and sortable.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists metrics with their sample and time-series counts for a time range — the volume view of the metrics explorer, pageable and sortable.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yMetricStatsIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricStatsOut>> getMetricsStats(
|
|
std::shared_ptr<O11y_O11yMetricStatsIn> o11yO11yMetricStatsIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the proportional distribution of metrics by sample count or time-series count, as the entries of a treemap.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the proportional distribution of metrics by sample count or time-series count, as the entries of a treemap.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yMetricTreemapIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricTreemapOut>> getMetricsTreemap(
|
|
std::shared_ptr<O11y_O11yMetricTreemapIn> o11yO11yMetricTreemapIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the caller's own organization.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the caller's own organization. Admin gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yOrganizationOut>> getMyOrganization(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the calling service account itself, with the roles it holds — the self-inspection read for a key-authenticated caller.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the calling service account itself, with the roles it holds — the self-inspection read for a key-authenticated caller.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yServiceAccountOut>> getMyServiceAccount(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the calling user together with every role they hold.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the calling user together with every role they hold. Open to any authenticated caller.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yUserWithRolesOut>> getMyUser(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the calling user with their single legacy role.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the calling user with their single legacy role. Deprecated in favor of getMyUser. Open to any authenticated caller.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yDeprecatedUserOut>> getMyUserDeprecated(
|
|
) const;
|
|
/// <summary>
|
|
/// Replay the alert records this process took
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Answers the most recent Alertmanager deliveries THIS process received, as plain text — one greppable `ALERT-RECEIVED` line per alert, followed by the `ALERT-DELIVERED` / `ALERT-UNDELIVERED` outcome of carrying it out of the process, newest last, so piping to `tail` reads in arrival order. `(none)` when nothing has landed. Arrival and delivery are separate lines because they are separate facts that fail independently. Alertmanager can tell you it dispatched a notification, never that anything received it; this process taking the call says nothing about whether a human was reached. Reading only the first as if it were the second is how a pager stays silent for months behind a log where everything looks fine. The ring is PROCESS-LOCAL and bounded to the last 200 lines. Both are the point: a record that outlived the process that took the call would be a claim about something nobody observed, and an unbounded log is a memory leak with a nice name. A restart empties it.
|
|
/// </remarks>
|
|
pplx::task<void> getO11yAlertsLast(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the attributes usable as an aggregate target for the given telemetry and operator — what a filter builder offers after the aggregation is chosen.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the attributes usable as an aggregate target for the given telemetry and operator — what a filter builder offers after the aggregation is chosen. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the attributes come from — traces, logs, metrics or meter. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the attribute will be used under, e.g. count, avg, sum. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the attributes to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many attributes come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAggregateAttributesOut>> getO11yAutocompleteAggregateAttributes(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the attribute keys available for filtering the given telemetry, each with its data type and whether it is a materialized column.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the attribute keys available for filtering the given telemetry, each with its data type and whether it is a materialized column. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — traces, logs, metrics or meter. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAttributeKeysOut>> getO11yAutocompleteAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one attribute key has taken — string, number and bool values in their own lists — for completing a filter.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one attribute key has taken — string, number and bool values in their own lists — for completing a filter. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — traces, logs or metrics. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAttributeValuesOut>> getO11yAutocompleteAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Reports how much of the Hanzo fleet is up — the current per-service inventory plus an up-versus-reporting trend across the window.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports how much of the Hanzo fleet is up — the current per-service inventory plus an up-versus-reporting trend across the window. Both come from the fleet prober's own measurements: every service is asked its health URL every 30 seconds, so a service is listed as down because it did not answer, never because something failed to collect it. PLATFORM SUDO ONLY — this is the whole fleet's inventory, not tenant data, so every customer is 403. An unreachable telemetry store answers 503 rather than an empty trend, because a board of zeroes and a fleet that is down look identical.
|
|
/// </remarks>
|
|
/// <param name="range">Range is the trend window in seconds. Default 3600, capped at 604800 (7d). (optional, default to 0L)</param>
|
|
/// <param name="stepSec">StepSec is the bucket width in seconds, clamped to [30, 3600]. Absent picks ~60 buckets across the range. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_availabilityResponse>> getO11yAvailability(
|
|
boost::optional<int64_t> range,
|
|
boost::optional<int64_t> stepSec
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys Kubernetes clusters report, for building cluster filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys Kubernetes clusters report, for building cluster filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yClustersAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one cluster attribute key has taken, for building cluster filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one cluster attribute key has taken, for building cluster filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yClustersAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Complete a Google sign-in
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The callback Google redirects a user back to after they approve the sign-in. It exchanges the authorization code, establishes the session and answers 303 to the console. The answer is a Location header and no body, which is why it is not a typed operation — declaring a JSON response for a redirect would publish a shape that does not exist and hide the header that is the entire point. UNAUTHENTICATED by necessity: it is how a caller GETS a principal, so requiring one would be circular. It is not an open endpoint — the code it carries is single-use and verified against the provider.
|
|
/// </remarks>
|
|
pplx::task<void> getO11yCompleteGoogle(
|
|
) const;
|
|
/// <summary>
|
|
/// Complete a generic OIDC sign-in
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The callback any configured OIDC provider redirects back to. Same shape and same reasoning as the Google callback: the code is exchanged, the session is established, and the answer is a 303 to the console rather than a body. UNAUTHENTICATED by necessity — this is the act of obtaining a principal, and the provider's own code is what authenticates it.
|
|
/// </remarks>
|
|
pplx::task<void> getO11yCompleteOidc(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys Kubernetes daemonsets report, for building daemonset filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys Kubernetes daemonsets report, for building daemonset filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yDaemonsetsAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one daemonset attribute key has taken, for building daemonset filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one daemonset attribute key has taken, for building daemonset filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yDaemonsetsAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys Kubernetes deployments report, for building deployment filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys Kubernetes deployments report, for building deployment filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yDeploymentsAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one deployment attribute key has taken, for building deployment filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one deployment attribute key has taken, for building deployment filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yDeploymentsAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the storage disks the datastore reports, with their names and types.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the storage disks the datastore reports, with their names and types. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::vector<std::shared_ptr<O11y_O11yDisk>>> getO11yDisks(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one exception instance and the span it happened on, by its error id within a group at a timestamp.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one exception instance and the span it happened on, by its error id within a group at a timestamp. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="timestamp">Timestamp is the instance's time as a nanosecond epoch spelled as a string. Required.</param>
|
|
/// <param name="groupID">GroupID is the exception group the instance belongs to. Required.</param>
|
|
/// <param name="errorID">ErrorID is the exception instance id. Required by errorFromErrorID and nextPrevErrorIDs; unused by errorFromGroupID. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yErrorWithSpan>> getO11yErrorfromerrorid(
|
|
utility::string_t timestamp,
|
|
utility::string_t groupID,
|
|
boost::optional<utility::string_t> errorID
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the representative exception instance of a group at a timestamp, and the span it happened on.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the representative exception instance of a group at a timestamp, and the span it happened on. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="timestamp">Timestamp is the instance's time as a nanosecond epoch spelled as a string. Required.</param>
|
|
/// <param name="groupID">GroupID is the exception group the instance belongs to. Required.</param>
|
|
/// <param name="errorID">ErrorID is the exception instance id. Required by errorFromErrorID and nextPrevErrorIDs; unused by errorFromGroupID. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yErrorWithSpan>> getO11yErrorfromgroupid(
|
|
utility::string_t timestamp,
|
|
utility::string_t groupID,
|
|
boost::optional<utility::string_t> errorID
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the caller's org's grouped error issues (by fingerprint) with status, level, counts and first/last-seen.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the caller's org's grouped error issues (by fingerprint) with status, level, counts and first/last-seen. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="status">Status narrows to one lifecycle state: unresolved, resolved or ignored. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="level">Level narrows to one severity, e.g. error, warning, info. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="environment">Environment narrows to one deployment environment. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="serviceName">ServiceName narrows to one reporting service. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="query">Query narrows to issues whose text contains it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="sort">Sort orders the page, e.g. lastSeen, firstSeen, count. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="offset">Offset is how many issues to skip. Zero starts at the first. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many issues come back. Zero means the default. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yErrorIssuesOut>> getO11yErrortrackingIssues(
|
|
boost::optional<utility::string_t> status,
|
|
boost::optional<utility::string_t> level,
|
|
boost::optional<utility::string_t> environment,
|
|
boost::optional<utility::string_t> serviceName,
|
|
boost::optional<utility::string_t> query,
|
|
boost::optional<utility::string_t> sort,
|
|
boost::optional<int64_t> offset,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one grouped issue with its latest occurrence sample.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one grouped issue with its latest occurrence sample. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the issue id.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yErrorGettableIssueOut>> getO11yErrortrackingIssuesById(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the caller's org's saved explorer views, optionally narrowed to one source page, name or category.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the caller's org's saved explorer views, optionally narrowed to one source page, name or category. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="sourcePage">SourcePage narrows the views to one source page, e.g. traces, logs. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="name">Name narrows the views to one name. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="category">Category narrows the views to one category. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySavedViewListOut>> getO11yExplorerViews(
|
|
boost::optional<utility::string_t> sourcePage,
|
|
boost::optional<utility::string_t> name,
|
|
boost::optional<utility::string_t> category
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one saved explorer view by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one saved explorer view by id. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="viewId">ViewID is the view's id.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySavedViewOut>> getO11yExplorerViewsByViewid(
|
|
utility::string_t viewId
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the supported feature flags and their resolved values for the caller's org.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the supported feature flags and their resolved values for the caller's org. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yFeaturesOut>> getO11yFeatures(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the telemetry field keys matching the selector — the signal's fields grouped by name, and whether the catalog is complete.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the telemetry field keys matching the selector — the signal's fields grouped by name, and whether the catalog is complete. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="signal">Signal is the telemetry to read the fields of — traces, logs or metrics. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="source">Source narrows the fields to one source within the signal. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. (optional, default to 0L)</param>
|
|
/// <param name="startUnixMilli">StartUnixMilli is the window start as a unix millisecond epoch. Zero reads as unset. (optional, default to 0L)</param>
|
|
/// <param name="endUnixMilli">EndUnixMilli is the window end as a unix millisecond epoch. Zero reads as unset. (optional, default to 0L)</param>
|
|
/// <param name="fieldContext">FieldContext narrows the keys to one context — resource, scope, attribute, span, log or metric. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="fieldDataType">FieldDataType narrows the keys to one data type. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="metricName">MetricName narrows the keys to those on one metric. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="metricNamespace">MetricNamespace narrows the keys to one metric namespace. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFieldKeysOut>> getO11yFieldsKeys(
|
|
boost::optional<utility::string_t> signal,
|
|
boost::optional<utility::string_t> source,
|
|
boost::optional<int64_t> limit,
|
|
boost::optional<int64_t> startUnixMilli,
|
|
boost::optional<int64_t> endUnixMilli,
|
|
boost::optional<utility::string_t> fieldContext,
|
|
boost::optional<utility::string_t> fieldDataType,
|
|
boost::optional<utility::string_t> metricName,
|
|
boost::optional<utility::string_t> metricNamespace,
|
|
boost::optional<utility::string_t> searchText
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the values one telemetry field has taken — string, bool, number and related values — and whether the value list is complete.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the values one telemetry field has taken — string, bool, number and related values — and whether the value list is complete. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="signal">Signal is the telemetry to read the field of — traces, logs or metrics. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="source">Source narrows the field to one source within the signal. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. (optional, default to 0L)</param>
|
|
/// <param name="startUnixMilli">StartUnixMilli is the window start as a unix millisecond epoch. Zero reads as unset. (optional, default to 0L)</param>
|
|
/// <param name="endUnixMilli">EndUnixMilli is the window end as a unix millisecond epoch. Zero reads as unset. (optional, default to 0L)</param>
|
|
/// <param name="fieldContext">FieldContext narrows the field to one context. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="fieldDataType">FieldDataType narrows the field to one data type. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="metricName">MetricName narrows the field to one metric. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="metricNamespace">MetricNamespace narrows the field to one metric namespace. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="name">Name is the field whose values to read. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="existingQuery">ExistingQuery is the query the field appears in, so related values can be suggested for it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFieldValuesOut>> getO11yFieldsValues(
|
|
boost::optional<utility::string_t> signal,
|
|
boost::optional<utility::string_t> source,
|
|
boost::optional<int64_t> limit,
|
|
boost::optional<int64_t> startUnixMilli,
|
|
boost::optional<int64_t> endUnixMilli,
|
|
boost::optional<utility::string_t> fieldContext,
|
|
boost::optional<utility::string_t> fieldDataType,
|
|
boost::optional<utility::string_t> metricName,
|
|
boost::optional<utility::string_t> metricNamespace,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> name,
|
|
boost::optional<utility::string_t> existingQuery
|
|
) const;
|
|
/// <summary>
|
|
/// Suggests attribute keys and example filter queries for the query builder, seeded by what the org's own telemetry carries.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Suggests attribute keys and example filter queries for the query builder, seeded by what the org's own telemetry carries. Only the logs data source is supported today. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the signal suggestions are drawn from; only logs is supported today. Required.</param>
|
|
/// <param name="searchText">SearchText narrows attribute suggestions to keys containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="existingFilter">ExistingFilter is the current filter set, JSON base64url-encoded, so example queries build on it rather than repeat it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributesLimit">AttributesLimit caps how many attribute keys come back. (optional, default to 0L)</param>
|
|
/// <param name="examplesLimit">ExamplesLimit caps how many example queries come back. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFilterSuggestionsOut>> getO11yFilterSuggestions(
|
|
utility::string_t dataSource,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> existingFilter,
|
|
boost::optional<int64_t> attributesLimit,
|
|
boost::optional<int64_t> examplesLimit
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the deployment's global configuration: its public endpoints and which identity providers are enabled.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the deployment's global configuration: its public endpoints and which identity providers are enabled. Open by design — the sign-in page reads it before anyone is signed in. Open by design; the runtime's own gate is OpenAccess.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yGlobalConfigOut>> getO11yGlobalConfig(
|
|
) const;
|
|
/// <summary>
|
|
/// Reports service health.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports service health. With live set, the datastore connection is checked too and an unhealthy store refuses with 503. Open by design; the runtime's own gate is OpenAccess.
|
|
/// </remarks>
|
|
/// <param name="live">Live also checks the datastore connection; an unreachable store refuses with 503. (optional, default to false)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yHealthOut>> getO11yHealth(
|
|
boost::optional<bool> live
|
|
) const;
|
|
/// <summary>
|
|
/// Health of the observability runtime's services
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports whether every service in the runtime's registry is healthy, and names them grouped by state — so a failure says WHICH component is down, not merely that something is. An unhealthy registry answers 503, not a 200 with a false flag inside, so a plain status check cannot read a sick runtime as well. UNAUTHENTICATED by design, like the other two probes: it carries no tenant data and is reached by k8s and by external checks that hold no principal.
|
|
/// </remarks>
|
|
pplx::task<void> getO11yHealthz(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys hosts report, for building host filters — each with its data type and whether it is a materialized column.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys hosts report, for building host filters — each with its data type and whether it is a materialized column.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yHostsAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one host attribute key has taken, for building host filters — string, number and bool values in their own lists.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one host attribute key has taken, for building host filters — string, number and bool values in their own lists.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yHostsAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Reports whether the metrics and attributes an infra-monitoring section needs are being received — for each collector receiver or processor involved, what is present and what is missing, with a user-facing message and a docs link per missing piece.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports whether the metrics and attributes an infra-monitoring section needs are being received — for each collector receiver or processor involved, what is present and what is missing, with a user-facing message and a docs link per missing piece. Ready is true only when nothing is missing.
|
|
/// </remarks>
|
|
/// <param name="type">Type is the section to check — hosts, processes, pods, nodes, deployments, daemonsets, statefulsets, jobs, namespaces, clusters or volumes. Required.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraChecksOut>> getO11yInfraMonitoringChecks(
|
|
utility::string_t type
|
|
) const;
|
|
/// <summary>
|
|
/// Reports how far Kubernetes infra onboarding has progressed: which metric families have arrived and, per pod, which required metadata labels are present.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports how far Kubernetes infra onboarding has progressed: which metric families have arrived and, per pod, which required metadata labels are present. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yOnboardingOut>> getO11yInfraOnboardingK8sStatus(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys Kubernetes jobs report, for building job filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys Kubernetes jobs report, for building job filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yJobsAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one job attribute key has taken, for building job filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one job attribute key has taken, for building job filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yJobsAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the org's licenses.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the org's licenses. This build has no enterprise edition, so the list is intentionally empty. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yLicensesOut>> getO11yLicenses(
|
|
) const;
|
|
/// <summary>
|
|
/// Activates the enterprise license.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Activates the enterprise license. This build has no enterprise edition, so the licensing provider refuses it as unsupported. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yLicenseActiveOut>> getO11yLicensesActive(
|
|
) const;
|
|
/// <summary>
|
|
/// Liveness of the observability process
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Answers 200 unconditionally while the process is running, and asserts NOTHING about the telemetry stores behind it. That is what makes it a liveness probe: a container that answers this is worth leaving alive, and restarting on a store outage would only remove the thing reporting the outage. UNAUTHENTICATED by design, and one of exactly three /v1/o11y paths that are. It carries no tenant data, and gating it would break the k8s probes and the external health checks without protecting anything. Use the health probe, not this one, to ask whether the runtime can actually serve.
|
|
/// </remarks>
|
|
pplx::task<void> getO11yLivez(
|
|
) const;
|
|
/// <summary>
|
|
/// Report why an observability sign-in did not complete
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Where a failed sign-in callback lands. The module builds that redirect with a path and no host, so it can only be same-origin, and its assumption is that the console lives beside the API. Here the console is a separate host, so this answers as the API it belongs to rather than redirecting onward — a hostname baked into a shared surface is how one brand's identity ends up in front of another brand's customer. 401 with the provider's own reason, carried from the query the module already populated. Unauthenticated by necessity: it exists precisely for the case where no principal was established.
|
|
/// </remarks>
|
|
pplx::task<void> getO11yLogin(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the most recent log records in the query window, newest first — each record an open object carrying its nanosecond timestamp and whatever fields the record was ingested with.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the most recent log records in the query window, newest first — each record an open object carrying its nanosecond timestamp and whatever fields the record was ingested with. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="limit">Limit caps how many records come back. Zero means the default of 100. (optional, default to 0L)</param>
|
|
/// <param name="timestampStart">TimestampStart is the start of the window as a nanosecond epoch. Zero means fifteen minutes before the end. (optional, default to 0L)</param>
|
|
/// <param name="timestampEnd">TimestampEnd is the end of the window as a nanosecond epoch. Zero means now. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLogRecordsOut>> getO11yLogs(
|
|
boost::optional<int64_t> limit,
|
|
boost::optional<int64_t> timestampStart,
|
|
boost::optional<int64_t> timestampEnd
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the logs aggregate buckets for the query window.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the logs aggregate buckets for the query window. The runtime currently answers the empty set; the shape is the contract. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yLogAggregateOut>> getO11yLogsAggregate(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the log field catalog: the fields already selected as indexed columns, and the interesting ones seen in the data that could be.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the log field catalog: the fields already selected as indexed columns, and the interesting ones seen in the data that could be. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yFieldCatalogOut>> getO11yLogsFields(
|
|
) const;
|
|
/// <summary>
|
|
/// Follow log records as they arrive
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Streams matching log records continuously instead of answering once, so a console tail shows lines as they land rather than at the end of a window. It is a STREAM, which is why it is not a typed operation: there is no single complete value to name, and a generated client that waited for one would hang on the first tail. Read the bounded window with the log read instead when you want an answer rather than a feed. A validated, org-scoped principal is required and the feed carries that principal's own tenant only.
|
|
/// </remarks>
|
|
pplx::task<void> getO11yLogsLivetail(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the caller's org's log parsing pipelines at one config version — \"latest\" for the newest — along with that version's deployment record and the recent version history.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the caller's org's log parsing pipelines at one config version — \"latest\" for the newest — along with that version's deployment record and the recent version history. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="version">Version is the config version to read — a positive number, or \"latest\".</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLogPipelinesOut>> getO11yLogsPipelinesByVersion(
|
|
utility::string_t version
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the log body paths already promoted or indexed, with the indexes each carries.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the log body paths already promoted or indexed, with the indexes each carries. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yLogPromotedOut>> getO11yLogsPromotePaths(
|
|
) const;
|
|
/// <summary>
|
|
/// Serves the OLDER /metric/metric_metadata route.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Serves the OLDER /metric/metric_metadata route. It is NOT the same op as metrics.go's metricMetadata (/metrics/metadata): different path, different input (this one also scopes by service). Two slices named one Go function for two routes; the route is the identity, so the name follows it. Renamed rather than merged — collapsing them would silently drop the service scope this one accepts. It returns one metric's metadata — its type, unit, description, temporality, monotonicity and histogram buckets — optionally scoped to the metric as one service reports it. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="metricName">MetricName is the metric to read. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="serviceName">ServiceName scopes the metadata to the metric as one service reports it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricMetadataOut>> getO11yMetricMetricMetadata(
|
|
boost::optional<utility::string_t> metricName,
|
|
boost::optional<utility::string_t> serviceName
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys Kubernetes namespaces report, for building namespace filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys Kubernetes namespaces report, for building namespace filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yNamespacesAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one namespace attribute key has taken, for building namespace filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one namespace attribute key has taken, for building namespace filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yNamespacesAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the ids of the exception instances immediately after and before a given one within its group — the paging cursor the error detail view walks.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the ids of the exception instances immediately after and before a given one within its group — the paging cursor the error detail view walks. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="timestamp">Timestamp is the instance's time as a nanosecond epoch spelled as a string. Required.</param>
|
|
/// <param name="groupID">GroupID is the exception group the instance belongs to. Required.</param>
|
|
/// <param name="errorID">ErrorID is the exception instance id. Required by errorFromErrorID and nextPrevErrorIDs; unused by errorFromGroupID. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yNextPrevErrorIDs>> getO11yNextpreverrorids(
|
|
utility::string_t timestamp,
|
|
utility::string_t groupID,
|
|
boost::optional<utility::string_t> errorID
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys Kubernetes nodes report, for building node filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys Kubernetes nodes report, for building node filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yNodesAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one node attribute key has taken, for building node filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one node attribute key has taken, for building node filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yNodesAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys Kubernetes pods report, for building pod filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys Kubernetes pods report, for building pod filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yPodsAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one pod attribute key has taken, for building pod filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one pod attribute key has taken, for building pod filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yPodsAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys processes report, for building process filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys processes report, for building process filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yProcessesAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one process attribute key has taken, for building process filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one process attribute key has taken, for building process filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yProcessesAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one product's RED series — request rate, errors, p50 and p95 latency — for the caller's org, plus that org's LLM usage rollup over the same window.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one product's RED series — request rate, errors, p50 and p95 latency — for the caller's org, plus that org's LLM usage rollup over the same window. The series come from org-tagged request spans, so a tenant only ever aggregates its own traffic; a validated platform SuperAdmin sees the whole product's RED, while usage stays the caller's own org either way. A well-formed product with no backing workload answers empty series; a malformed slug is a 400.
|
|
/// </remarks>
|
|
/// <param name="product">Product is the console product slug to read, e.g. \"kms\". Required. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="range">Range is the window in seconds. Default 3600, capped at 604800 (7d). (optional, default to 0L)</param>
|
|
/// <param name="stepSec">StepSec is the bucket width in seconds, clamped to [30, 3600]. Absent picks ~60 buckets across the range. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_metricsResponse>> getO11yProductMetrics(
|
|
boost::optional<utility::string_t> product,
|
|
boost::optional<int64_t> range,
|
|
boost::optional<int64_t> stepSec
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys persistent volume claims report, for building volume filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys persistent volume claims report, for building volume filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yPvcsAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one persistent-volume-claim attribute key has taken, for building volume filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one persistent-volume-claim attribute key has taken, for building volume filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yPvcsAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Evaluates one instant PromQL query against the org's metrics and returns the result at a single point in time.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Evaluates one instant PromQL query against the org's metrics and returns the result at a single point in time. The result is polymorphic by PromQL's own contract — a matrix, vector, scalar or string, discriminated by resultType — so it is carried verbatim rather than forced into one of its shapes. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="query">Query is the PromQL expression to evaluate. Required.</param>
|
|
/// <param name="time">Time is the evaluation timestamp — epoch seconds or RFC3339. Empty evaluates at now. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="stats">Stats set to any non-empty value includes query statistics in the answer. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="timeout">Timeout caps evaluation time, as a duration in seconds. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yPromQueryOut>> getO11yQuery(
|
|
utility::string_t query,
|
|
boost::optional<utility::string_t> time,
|
|
boost::optional<utility::string_t> stats,
|
|
boost::optional<utility::string_t> timeout
|
|
) const;
|
|
/// <summary>
|
|
/// Watch one running query's progress
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports how far a submitted query has got — rows scanned, bytes read, elapsed — and HOLDS the connection until the next update rather than answering immediately. ONE ADDRESS, TWO PROTOCOLS. Send an Upgrade and this is a websocket carrying the same progress; send an ordinary GET and it is a long poll. The Upgrade is a property of the request, not of the address, so the read that used to answer at /ws/query_progress answers here. The long poll is the whole point, and the reason this cannot be a typed operation: an answer that arrived only when the query finished would report progress on nothing, and an upgraded connection has no JSON response to declare. A validated, org-scoped principal is required; a query id belonging to another tenant is simply not found.
|
|
/// </remarks>
|
|
pplx::task<void> getO11yQueryProgress(
|
|
) const;
|
|
/// <summary>
|
|
/// Runs a Prometheus-style range query over metrics — the legacy read that predates the v5 querier — and returns the matrix, vector or scalar the query resolved to.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Runs a Prometheus-style range query over metrics — the legacy read that predates the v5 querier — and returns the matrix, vector or scalar the query resolved to. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="start">Start is the window start — a unix timestamp (seconds, with optional fraction) or an RFC 3339 time. Required.</param>
|
|
/// <param name="end">End is the window end, in the same form as Start, and not before it. Required.</param>
|
|
/// <param name="step">Step is the query resolution, e.g. 60s, 1m, 1h — a positive duration. Required.</param>
|
|
/// <param name="query">Query is the PromQL expression to evaluate. Required.</param>
|
|
/// <param name="stats">Stats, when \"all\", asks for query statistics alongside the result. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="timeout">Timeout caps how long the query may run, e.g. 30s, 1m — a positive duration. Absent means the server default. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricsQueryRangeOut>> getO11yQueryRange(
|
|
utility::string_t start,
|
|
utility::string_t end,
|
|
utility::string_t step,
|
|
utility::string_t query,
|
|
boost::optional<utility::string_t> stats,
|
|
boost::optional<utility::string_t> timeout
|
|
) const;
|
|
/// <summary>
|
|
/// Readiness of the observability runtime to serve
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports whether the runtime's registered services are healthy enough to take traffic, and answers 503 when they are not — which is what takes a booting or degraded replica out of the load balancer instead of letting it serve errors. UNAUTHENTICATED by design, like the other two probes. It reads the same service registry the health probe reads, so the two agree by construction; readiness is the question a router asks and health is the question an operator asks.
|
|
/// </remarks>
|
|
pplx::task<void> getO11yReadyz(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a page of the caller org's human-review queues, newest first, narrowed to the caller's project.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a page of the caller org's human-review queues, newest first, narrowed to the caller's project. Another org's queues are never visible.
|
|
/// </remarks>
|
|
/// <param name="page">Page is the 1-based page to read. Default 1. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit is how many rows to return. Default 20, capped at 100. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_annQueueList>> getO11yReviews(
|
|
boost::optional<int64_t> page,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one review queue with its pending and completed counts and its first page of items.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one review queue with its pending and completed counts and its first page of items. A queue id belonging to another org is a 404, never a cross-tenant read.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the annotation queue to act on, from the path.</param>
|
|
pplx::task<std::shared_ptr<O11y_annQueueDetailView>> getO11yReviewsById(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a page of one review queue's items, newest first, optionally filtered to PENDING or COMPLETED.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a page of one review queue's items, newest first, optionally filtered to PENDING or COMPLETED. A queue id belonging to another org is a 404, never a cross-tenant list.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the annotation queue whose items to list, from the path.</param>
|
|
/// <param name="status">Status filters to PENDING or COMPLETED items. Absent returns both. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="page">Page is the 1-based page to read. Default 1. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit is how many rows to return. Default 20, capped at 100. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_annItemList>> getO11yReviewsByIdItems(
|
|
utility::string_t id,
|
|
boost::optional<utility::string_t> status,
|
|
boost::optional<int64_t> page,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one captured error event of a project, by its id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one captured error event of a project, by its id. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the event id.</param>
|
|
/// <param name="project">Project is the project the event belongs to, by its id. Required.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySentryEventOut>> getO11ySentinelEventsById(
|
|
utility::string_t id,
|
|
utility::string_t project
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the caller's org's grouped error issues, optionally narrowed to one project and one time window, and filtered by status, level, environment, service, a free-text query and a sort.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the caller's org's grouped error issues, optionally narrowed to one project and one time window, and filtered by status, level, environment, service, a free-text query and a sort. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="status">Status narrows to one lifecycle state: unresolved, resolved or ignored. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="level">Level narrows to one severity, e.g. error, warning, info. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="environment">Environment narrows to one deployment environment. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="serviceName">ServiceName narrows to one reporting service. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="query">Query narrows to issues whose text contains it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="sort">Sort orders the page, e.g. lastSeen, firstSeen, count. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="offset">Offset is how many issues to skip. Zero starts at the first. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many issues come back. Zero means the default. (optional, default to 0L)</param>
|
|
/// <param name="project">Project narrows the org's issues to one project, by its id. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="period">Period is the window to read, relative to now — 1h, 24h, 7d, 14d, 30d. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yErrorIssuesOut>> getO11ySentinelIssues(
|
|
boost::optional<utility::string_t> status,
|
|
boost::optional<utility::string_t> level,
|
|
boost::optional<utility::string_t> environment,
|
|
boost::optional<utility::string_t> serviceName,
|
|
boost::optional<utility::string_t> query,
|
|
boost::optional<utility::string_t> sort,
|
|
boost::optional<int64_t> offset,
|
|
boost::optional<int64_t> limit,
|
|
boost::optional<utility::string_t> project,
|
|
boost::optional<utility::string_t> period
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one grouped issue of the caller's org with its latest occurrence sample.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one grouped issue of the caller's org with its latest occurrence sample. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the issue id.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yErrorGettableIssueOut>> getO11ySentinelIssuesById(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Lists one issue's captured occurrences, scoped to a project — a project is an isolation unit, so the caller declares which project's occurrences to read.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists one issue's captured occurrences, scoped to a project — a project is an isolation unit, so the caller declares which project's occurrences to read. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the issue id.</param>
|
|
/// <param name="project">Project is the project whose occurrences to read, by its id. Required.</param>
|
|
/// <param name="limit">Limit caps how many occurrences come back. Zero means the default. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySentryIssueEventsOut>> getO11ySentinelIssuesByIdEvents(
|
|
utility::string_t id,
|
|
utility::string_t project,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists a project's captured error events, newest first, optionally narrowed to those whose message or exception text contains a search string.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists a project's captured error events, newest first, optionally narrowed to those whose message or exception text contains a search string.
|
|
/// </remarks>
|
|
/// <param name="project">Project is the project to read, as its id. Required.</param>
|
|
/// <param name="query">Query narrows the page to events whose text contains it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="period">Period is the window to read, relative to now — 1h, 24h, 7d, 14d, 30d. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many events come back. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLogsOut>> getO11ySentinelLogs(
|
|
utility::string_t project,
|
|
boost::optional<utility::string_t> query,
|
|
boost::optional<utility::string_t> period,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the caller's org's Sentry projects, each with its freshly-derived DSN.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the caller's org's Sentry projects, each with its freshly-derived DSN. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11ySentryProjectsOut>> getO11ySentinelProjects(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one Sentry project of the caller's org, DSN included.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one Sentry project of the caller's org, DSN included. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the project id.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySentryProjectOut>> getO11ySentinelProjectsById(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a project's event-rate timeseries: one bucket per interval over the requested period, counting the events in it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a project's event-rate timeseries: one bucket per interval over the requested period, counting the events in it.
|
|
/// </remarks>
|
|
/// <param name="project">Project is the project to read, as its id. Required.</param>
|
|
/// <param name="field">Field is the dimension to count over. Empty counts all events. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="period">Period is the window to read, relative to now — 1h, 24h, 7d, 14d, 30d. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yStatsOut>> getO11ySentinelStats(
|
|
utility::string_t project,
|
|
boost::optional<utility::string_t> field,
|
|
boost::optional<utility::string_t> period
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the traces a project's captured errors reference, each with how many errors landed on it, when they started and stopped, and the latest message seen — the entry point for \"which requests are failing\".
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the traces a project's captured errors reference, each with how many errors landed on it, when they started and stopped, and the latest message seen — the entry point for \"which requests are failing\".
|
|
/// </remarks>
|
|
/// <param name="project">Project is the project to read, as its id. Required.</param>
|
|
/// <param name="period">Period is the window to read, relative to now — 1h, 24h, 7d, 14d, 30d. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many traces come back. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yTracesOut>> getO11ySentinelTraces(
|
|
utility::string_t project,
|
|
boost::optional<utility::string_t> period,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one trace's captured errors for a project — every error event that carried the trace id, in the order the events plane holds them.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one trace's captured errors for a project — every error event that carried the trace id, in the order the events plane holds them.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the trace id.</param>
|
|
/// <param name="project">Project is the project the trace's errors belong to. Required.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yTraceOut>> getO11ySentinelTracesById(
|
|
utility::string_t id,
|
|
utility::string_t project
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the name of every service the trace store holds, with no window applied — the complete catalog, for pickers and autocomplete.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the name of every service the trace store holds, with no window applied — the complete catalog, for pickers and autocomplete.
|
|
/// </remarks>
|
|
pplx::task<std::vector<utility::string_t>> getO11yServicesList(
|
|
) const;
|
|
/// <summary>
|
|
/// List the caller org's LLM sessions
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Answers the caller org's LLM-observability sessions — traces grouped by session id on the gen_ai span plane — paged by limit and offset, in the runtime's own envelope, passed through unchanged. An org-less caller is refused HERE, at the cloud boundary, before the request reaches the runtime, and the org the runtime then scopes on is that SAME validated tenant. The two cannot disagree: the tenant is minted from the principal's own claim at ingress and a client copy never survives it. There is deliberately no session-detail route to pair with this. The runtime serves the list only; detail is composed client-side from this list plus the traces filtered by session, so a caller looking for one is looking for something that was never served rather than something that broke.
|
|
/// </remarks>
|
|
pplx::task<void> getO11ySessions(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns apdex settings for the named services.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns apdex settings for the named services. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="services">Services are the service names, comma separated. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yApdexOut>> getO11ySettingsApdex(
|
|
boost::optional<utility::string_t> services
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the org's current retention policy: default TTL, custom per-label rules, and cold-storage settings where configured.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the org's current retention policy: default TTL, custom per-label rules, and cold-storage settings where configured. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yRetentionOut>> getO11ySettingsTtl(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the metric attribute keys Kubernetes statefulsets report, for building statefulset filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the metric attribute keys Kubernetes statefulsets report, for building statefulset filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the keys come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the keys will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the keys must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the keys to one kind — tag or resource. Empty means all; an invalid value reads as empty. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeKeysOut>> getO11yStatefulsetsAttributeKeys(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the values one statefulset attribute key has taken, for building statefulset filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the values one statefulset attribute key has taken, for building statefulset filters.
|
|
/// </remarks>
|
|
/// <param name="dataSource">DataSource is the telemetry the values come from — metrics for the infra faces. The runtime requires it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateOperator">AggregateOperator is the aggregation the values will be used under, e.g. noop, count, avg. The runtime requires it for non-metrics sources. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="aggregateAttribute">AggregateAttribute is the metric the values must appear on. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="attributeKey">AttributeKey is the key whose values to list. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterAttributeKeyDataType">FilterAttributeKeyDataType is the key's data type — string, int64, float64 or bool. Empty means unspecified. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="searchText">SearchText narrows the values to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="tagType">TagType narrows the search to one kind of key — tag or resource. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many values come back. Absent means 50. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraAttributeValuesOut>> getO11yStatefulsetsAttributeValues(
|
|
boost::optional<utility::string_t> dataSource,
|
|
boost::optional<utility::string_t> aggregateOperator,
|
|
boost::optional<utility::string_t> aggregateAttribute,
|
|
boost::optional<utility::string_t> attributeKey,
|
|
boost::optional<utility::string_t> filterAttributeKeyDataType,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> tagType,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the collected usage statistics for the caller's org, as the stats reporter aggregates them — a map whose keys are the reporter's own counter names.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the collected usage statistics for the caller's org, as the stats reporter aggregates them — a map whose keys are the reporter's own counter names. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yOrgStatsOut>> getO11yStats(
|
|
) const;
|
|
/// <summary>
|
|
/// Reports whether a product's service is live: an in-cluster health probe with its measured latency, fused with the per-replica up inventory.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports whether a product's service is live: an in-cluster health probe with its measured latency, fused with the per-replica up inventory. Infra health is not tenant-partitioned — a service is up or down for everyone — so any validated caller is served, but an unvalidated one is refused. A product with no backing workload answers down/unknown-service without probing anything; a malformed slug is a 400.
|
|
/// </remarks>
|
|
/// <param name="product">Product is the console product slug to probe, e.g. \"kms\". Required. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_statusResult>> getO11yStatus(
|
|
boost::optional<utility::string_t> product
|
|
) const;
|
|
/// <summary>
|
|
/// Reports whether the platform is up.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports whether the platform is up. It returns the public status document: the incidents currently open against Hanzo's own services, derived from the fleet health probes, plus the address of the human status page. No authentication is required and no tenant data is involved — the answer is the same for every caller. A service that fails its health probe becomes one incident naming that service. When the availability source itself cannot be read the endpoint answers 503 rather than an empty incident list, because \"we cannot tell\" and \"everything is fine\" are different answers and only one of them is true.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_StatusSummary>> getO11ySummary(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the caller org's recent traces — one row per trace with its span count and wall-clock duration, most recently active first.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the caller org's recent traces — one row per trace with its span count and wall-clock duration, most recently active first. This is the trace SEARCH: it is where a trace id comes from, and the spans behind any row are then read from GET /v1/o11y/traces/{traceId}. Every row belongs to the caller's own org — the tenant is the validated principal, never an input, and there is no administrator widening, because a trace list is a tenant's records rather than a rollup over them. An unreachable telemetry store answers 503 rather than an empty page, because \"no traces\" and \"cannot see the traces\" are different facts and only one of them is about the caller's system.
|
|
/// </remarks>
|
|
/// <param name="range">Range is the window in seconds, counted back from now over each trace's last activity. Default 3600, capped at 604800 (7d). (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit is how many traces to return. Default 50, capped at 500. (optional, default to 0L)</param>
|
|
/// <param name="minDurationMs">MinDurationMs keeps only traces that lasted at least this many milliseconds. Zero or absent keeps every trace in the window. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_tracesOut>> getO11yTraces(
|
|
boost::optional<int64_t> range,
|
|
boost::optional<int64_t> limit,
|
|
boost::optional<int64_t> minDurationMs
|
|
) const;
|
|
/// <summary>
|
|
/// Returns ingestion usage counts bucketed over the requested window, optionally narrowed to one service.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns ingestion usage counts bucketed over the requested window, optionally narrowed to one service. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="start">Start is the window start, as epoch nanoseconds. Required.</param>
|
|
/// <param name="end">End is the window end, as epoch nanoseconds. Required.</param>
|
|
/// <param name="step">Step is the bucket width in seconds. The runtime requires it. (optional, default to 0L)</param>
|
|
/// <param name="service">Service narrows usage to one service. Empty covers all. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::vector<std::shared_ptr<O11y_O11yUsageItem>>> getO11yUsage(
|
|
utility::string_t start,
|
|
utility::string_t end,
|
|
boost::optional<int64_t> step,
|
|
boost::optional<utility::string_t> service
|
|
) const;
|
|
/// <summary>
|
|
/// Reports the running build: its version, whether an enterprise edition is present (\"N\" in this build), and whether first-user setup has completed.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reports the running build: its version, whether an enterprise edition is present (\"N\" in this build), and whether first-user setup has completed. Open by design; the runtime's own gate is OpenAccess.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yVersionOut>> getO11yVersion(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one org-scoped preference, by name.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one org-scoped preference, by name. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="name"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yPreferenceOut>> getOrgPreference(
|
|
utility::string_t name
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the overall firing/inactive windows for a rule, for the posted query range.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the overall firing/inactive windows for a rule, for the posted query range. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yRuleHistoryQueryIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yOverallStateTransitionsOut>> getOverallStateTransitions(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yRuleHistoryQueryIn> o11yO11yRuleHistoryQueryIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the public-sharing config for a dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the public-sharing config for a dashboard. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yPublicDashboardOut>> getPublicDashboard(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the sanitized dashboard data for public access — the read a shared dashboard's public page makes.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the sanitized dashboard data for public access — the read a shared dashboard's public page makes. Anonymous, scoped to the public dashboard's read scope; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yPublicDashboardDataOut>> getPublicDashboardData(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the query-range result for one widget of a public dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the query-range result for one widget of a public dashboard. When the share fixes its own time range the caller's startTime/endTime are ignored; otherwise they bound the window as millisecond epochs. Anonymous, scoped to the public dashboard's read scope; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the public dashboard id from the path.</param>
|
|
/// <param name="idx">Idx is the widget's index from the path.</param>
|
|
/// <param name="startTime">StartTime is the window start as a millisecond epoch. Used only when the share enables a caller-chosen time range. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="endTime">EndTime is the window end as a millisecond epoch. Used only when the share enables a caller-chosen time range. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yWidgetQueryRangeOut>> getPublicDashboardWidgetQueryRange(
|
|
utility::string_t id,
|
|
utility::string_t idx,
|
|
boost::optional<utility::string_t> startTime,
|
|
boost::optional<utility::string_t> endTime
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the org's quick filters for every signal — the attribute shortlists its explorers offer as one-click filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the org's quick filters for every signal — the attribute shortlists its explorers offer as one-click filters. Viewer gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yQuickFiltersOut>> getQuickFilters(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the reset-password token a user already has; absent one, the answer is a not-found rather than a fresh token.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the reset-password token a user already has; absent one, the answer is a not-found rather than a fresh token. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yResetTokenOut>> getResetPasswordToken(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a user's password-reset token, creating one if none is live.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a user's password-reset token, creating one if none is live. Deprecated in favor of the reset_password_tokens pair, which separates reading from minting. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yResetTokenOut>> getResetPasswordTokenDeprecated(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one role with the transaction groups it grants.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one role with the transaction groups it grants.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRoleOut>> getRole(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns every role one org member holds, by user id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns every role one org member holds, by user id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRolesOut>> getRolesByUserID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one route policy, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one route policy, by id. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRoutePolicyOut>> getRoutePolicyByID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one alert rule with its evaluation state, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one alert rule with its evaluation state, by id. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleOut>> getRuleByID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the distinct label keys present in a rule's history entries over the selected range, for building history filters.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the distinct label keys present in a rule's history entries over the selected range, for building history filters. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="startUnixMilli">StartUnixMilli is the window start, unix milliseconds. (optional, default to 0L)</param>
|
|
/// <param name="endUnixMilli">EndUnixMilli is the window end, unix milliseconds. (optional, default to 0L)</param>
|
|
/// <param name="searchText">SearchText narrows the keys to those containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many keys come back. Absent means 50, capped at 200. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleHistoryFilterKeysOut>> getRuleHistoryFilterKeys(
|
|
utility::string_t id,
|
|
boost::optional<int64_t> startUnixMilli,
|
|
boost::optional<int64_t> endUnixMilli,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the distinct values a given label key has taken across a rule's history entries.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the distinct values a given label key has taken across a rule's history entries. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="name">Name is the label key whose values to list. Required.</param>
|
|
/// <param name="startUnixMilli"> (optional, default to 0L)</param>
|
|
/// <param name="endUnixMilli"> (optional, default to 0L)</param>
|
|
/// <param name="searchText"> (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit"> (optional, default to 0L)</param>
|
|
/// <param name="existingQuery">ExistingQuery is a filter expression scoping which values appear. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleHistoryFilterValuesOut>> getRuleHistoryFilterValues(
|
|
utility::string_t id,
|
|
utility::string_t name,
|
|
boost::optional<int64_t> startUnixMilli,
|
|
boost::optional<int64_t> endUnixMilli,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<int64_t> limit,
|
|
boost::optional<utility::string_t> existingQuery
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the overall firing/inactive intervals for a rule over the selected range.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the overall firing/inactive intervals for a rule over the selected range. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="start">Start is the window start, unix milliseconds. Required by the runtime. (optional, default to 0L)</param>
|
|
/// <param name="end">End is the window end, unix milliseconds. Required by the runtime. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleHistoryOverallStatusOut>> getRuleHistoryOverallStatus(
|
|
utility::string_t id,
|
|
boost::optional<int64_t> start,
|
|
boost::optional<int64_t> end
|
|
) const;
|
|
/// <summary>
|
|
/// Returns trigger and resolution statistics for a rule over the selected time range, current window against the prior one.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns trigger and resolution statistics for a rule over the selected time range, current window against the prior one. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="start">Start is the window start, unix milliseconds. Required by the runtime. (optional, default to 0L)</param>
|
|
/// <param name="end">End is the window end, unix milliseconds. Required by the runtime. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleHistoryStatsOut>> getRuleHistoryStats(
|
|
utility::string_t id,
|
|
boost::optional<int64_t> start,
|
|
boost::optional<int64_t> end
|
|
) const;
|
|
/// <summary>
|
|
/// Returns paginated timeline entries for a rule's state transitions, filterable by state and a label expression, cursor-paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns paginated timeline entries for a rule's state transitions, filterable by state and a label expression, cursor-paginated. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="start">Start is the window start, unix milliseconds. Required by the runtime. (optional, default to 0L)</param>
|
|
/// <param name="end">End is the window end, unix milliseconds. Required by the runtime. (optional, default to 0L)</param>
|
|
/// <param name="state">State keeps only entries in one alert state, e.g. firing or normal. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="filterExpression">FilterExpression narrows entries to those whose labels match it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many entries come back. Absent means 50. (optional, default to 0L)</param>
|
|
/// <param name="order">Order sorts by time, asc or desc. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="cursor">Cursor resumes a previous page; opaque, returned as nextCursor. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleHistoryTimelineOut>> getRuleHistoryTimeline(
|
|
utility::string_t id,
|
|
boost::optional<int64_t> start,
|
|
boost::optional<int64_t> end,
|
|
boost::optional<utility::string_t> state,
|
|
boost::optional<utility::string_t> filterExpression,
|
|
boost::optional<int64_t> limit,
|
|
boost::optional<utility::string_t> order,
|
|
boost::optional<utility::string_t> cursor
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the label combinations that contributed most to a rule firing over the selected range.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the label combinations that contributed most to a rule firing over the selected range. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="start">Start is the window start, unix milliseconds. Required by the runtime. (optional, default to 0L)</param>
|
|
/// <param name="end">End is the window end, unix milliseconds. Required by the runtime. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleHistoryContributorsOut>> getRuleHistoryTopContributors(
|
|
utility::string_t id,
|
|
boost::optional<int64_t> start,
|
|
boost::optional<int64_t> end
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a rule's state-transition timeline for the posted query range, each entry carrying its related-logs or related-traces link.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a rule's state-transition timeline for the posted query range, each entry carrying its related-logs or related-traces link. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yRuleHistoryQueryIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleStateTimelineOut>> getRuleStateHistory(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yRuleHistoryQueryIn> o11yO11yRuleHistoryQueryIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the label combinations that contributed most to a rule firing, for the posted query range.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the label combinations that contributed most to a rule firing, for the posted query range. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yRuleHistoryQueryIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleStateContributorsOut>> getRuleStateHistoryTopContributors(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yRuleHistoryQueryIn> o11yO11yRuleHistoryQueryIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns trigger and resolution statistics for a rule, current window against the prior one, for the posted query range.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns trigger and resolution statistics for a rule, current window against the prior one, for the posted query range. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yRuleHistoryQueryIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleStatsOut>> getRuleStats(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yRuleHistoryQueryIn> o11yO11yRuleHistoryQueryIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one service the given provider can collect from, by service id, optionally scoped to one cloud integration.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one service the given provider can collect from, by service id, optionally scoped to one cloud integration. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="serviceId"></param>
|
|
/// <param name="cloudIntegrationId">CloudIntegrationID, when set, scopes the service to one cloud integration. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yServiceOut>> getService(
|
|
utility::string_t cloudProvider,
|
|
utility::string_t serviceId,
|
|
boost::optional<utility::string_t> cloudIntegrationId
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one service account with the roles it holds.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one service account with the roles it holds.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yServiceAccountOut>> getServiceAccount(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the roles a service account holds.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the roles a service account holds.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yServiceAccountRolesOut>> getServiceAccountRoles(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Tells a sign-in page what an email address can do: which orgs the address belongs to and, per org, which password and SSO routes are open to it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Tells a sign-in page what an email address can do: which orgs the address belongs to and, per org, which password and SSO routes are open to it. Unauthenticated: it runs before any session exists.
|
|
/// </remarks>
|
|
/// <param name="email">Email is the address about to sign in. Required. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="ref">Ref is the page the sign-in started from, carried into SSO redirects. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySessionContextOut>> getSessionContext(
|
|
boost::optional<utility::string_t> email,
|
|
boost::optional<utility::string_t> ref
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the org's quick filters for one signal — traces, logs, metrics, exceptions or api_monitoring.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the org's quick filters for one signal — traces, logs, metrics, exceptions or api_monitoring. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="signal"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySignalFiltersOut>> getSignalFilters(
|
|
utility::string_t signal
|
|
) const;
|
|
/// <summary>
|
|
/// Computes span aggregations over one trace — span count, duration or share of execution time — grouped by the resource field each aggregation names.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Computes span aggregations over one trace — span count, duration or share of execution time — grouped by the resource field each aggregation names. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="traceId"></param>
|
|
/// <param name="o11yO11yTraceAggregationsIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yTraceAggregationsOut>> getTraceAggregations(
|
|
utility::string_t traceId,
|
|
std::shared_ptr<O11y_O11yTraceAggregationsIn> o11yO11yTraceAggregationsIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the trace field catalog: the span fields already selected as indexed columns, and the interesting ones seen in the data that could be.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the trace field catalog: the span fields already selected as indexed columns, and the interesting ones seen in the data that could be. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yFieldCatalogOut>> getTraceFields(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one funnel with its steps.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one funnel with its steps. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="funnelId"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelOut>> getTraceFunnel(
|
|
utility::string_t funnelId
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the errored traces through a step transition of a saved funnel — the entry point for \"why is this step failing\".
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the errored traces through a step transition of a saved funnel — the entry point for \"why is this step failing\".
|
|
/// </remarks>
|
|
/// <param name="funnelId"></param>
|
|
/// <param name="o11yO11yFunnelStepWindowIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> getTraceFunnelErrorTraces(
|
|
utility::string_t funnelId,
|
|
std::shared_ptr<O11y_O11yFunnelStepWindowIn> o11yO11yFunnelStepWindowIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a saved funnel's conversion overview over a window: how many entered, how many converted, the rate and the latency.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a saved funnel's conversion overview over a window: how many entered, how many converted, the rate and the latency.
|
|
/// </remarks>
|
|
/// <param name="funnelId"></param>
|
|
/// <param name="o11yO11yFunnelStepWindowIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> getTraceFunnelOverview(
|
|
utility::string_t funnelId,
|
|
std::shared_ptr<O11y_O11yFunnelStepWindowIn> o11yO11yFunnelStepWindowIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the slowest traces through a step transition of a saved funnel — the entry point for \"why is this step slow\".
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the slowest traces through a step transition of a saved funnel — the entry point for \"why is this step slow\".
|
|
/// </remarks>
|
|
/// <param name="funnelId"></param>
|
|
/// <param name="o11yO11yFunnelStepWindowIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> getTraceFunnelSlowTraces(
|
|
utility::string_t funnelId,
|
|
std::shared_ptr<O11y_O11yFunnelStepWindowIn> o11yO11yFunnelStepWindowIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a saved funnel's per-step metrics over a window — the counts and latencies at each step, in step order.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a saved funnel's per-step metrics over a window — the counts and latencies at each step, in step order.
|
|
/// </remarks>
|
|
/// <param name="funnelId"></param>
|
|
/// <param name="o11yO11yFunnelWindowIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> getTraceFunnelStepMetrics(
|
|
utility::string_t funnelId,
|
|
std::shared_ptr<O11y_O11yFunnelWindowIn> o11yO11yFunnelWindowIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the conversion between two named steps of a saved funnel — the step-to-step drill-down behind the overview.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the conversion between two named steps of a saved funnel — the step-to-step drill-down behind the overview.
|
|
/// </remarks>
|
|
/// <param name="funnelId"></param>
|
|
/// <param name="o11yO11yFunnelStepWindowIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> getTraceFunnelStepOverview(
|
|
utility::string_t funnelId,
|
|
std::shared_ptr<O11y_O11yFunnelStepWindowIn> o11yO11yFunnelStepWindowIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one org member together with every role they hold, by user id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one org member together with every role they hold, by user id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yUserWithRolesOut>> getUser(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one org member with their single legacy role, by user id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one org member with their single legacy role, by user id. Admins may read anyone; a non-admin only themselves (the runtime's self-access gate).
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDeprecatedUserOut>> getUserDeprecated(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one preference of the calling user, by name.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one preference of the calling user, by name. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="name"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yPreferenceOut>> getUserPreference(
|
|
utility::string_t name
|
|
) const;
|
|
/// <summary>
|
|
/// Returns every org member holding a role, by role id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns every org member holding a role, by role id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yUsersOut>> getUsersByRoleID(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a trace's waterfall: every span when the trace is small enough, a capped window around the selected span when it is not, with the uncollapsed subtrees the caller asked to keep open.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a trace's waterfall: every span when the trace is small enough, a capped window around the selected span when it is not, with the uncollapsed subtrees the caller asked to keep open. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="traceId"></param>
|
|
/// <param name="o11yO11yTraceWaterfallIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yTraceWaterfallOut>> getWaterfallV4(
|
|
utility::string_t traceId,
|
|
std::shared_ptr<O11y_O11yTraceWaterfallIn> o11yO11yTraceWaterfallIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one metric's raw time series over a window of at most thirty minutes — each series with its labels and timestamp/value pairs.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one metric's raw time series over a window of at most thirty minutes — each series with its labels and timestamp/value pairs.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yMetricInspectIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricInspectOut>> inspectMetrics(
|
|
std::shared_ptr<O11y_O11yMetricInspectIn> o11yO11yMetricInspectIn
|
|
) const;
|
|
/// <summary>
|
|
/// Installs an integration into the caller's org from its id and configuration, answering with the installed catalog item.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Installs an integration into the caller's org from its id and configuration, answering with the installed catalog item. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="o11yInstallIntegrationRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInstallOut>> installIntegration(
|
|
std::shared_ptr<O11y_InstallIntegrationRequest> o11yInstallIntegrationRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the services metadata for one connected account of the given provider, by account id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the services metadata for one connected account of the given provider, by account id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yServicesMetadataOut>> listAccountServicesMetadata(
|
|
utility::string_t cloudProvider,
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the cloud-integration accounts connected for the given provider.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the cloud-integration accounts connected for the given provider. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAccountsOut>> listAccounts(
|
|
utility::string_t cloudProvider
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the org's auth domains — the email domains whose SSO configuration this org owns.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the org's auth domains — the email domains whose SSO configuration this org owns. Admin gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yAuthDomainsOut>> listAuthDomains(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the org's notification channels.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the org's notification channels. Viewer gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yChannelsOut>> listChannels(
|
|
) const;
|
|
/// <summary>
|
|
/// Returns every saved view in the calling user's org.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns every saved view in the calling user's org. Saved views are shared org-wide. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardViewListOut>> listDashboardViews(
|
|
) const;
|
|
/// <summary>
|
|
/// Is dashboardListV2 personalized for the calling user: each dashboard carries the caller's pinned state, and pinned dashboards float to the top of the requested ordering.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Is dashboardListV2 personalized for the calling user: each dashboard carries the caller's pinned state, and pinned dashboards float to the top of the requested ordering. Supports the same filter DSL, sort, order and pagination. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="query">Query is the filter DSL over dashboard columns and tags, e.g. `name:cpu source:user`. Empty lists everything. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="sort">Sort is the sort field: updated_at, created_at or name. Empty sorts by updated_at. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="order">Order is the sort direction: asc or desc. Empty orders desc. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many dashboards come back. Zero means the default of 20; the runtime caps it at 200. (optional, default to 0L)</param>
|
|
/// <param name="offset">Offset is how many dashboards to skip for pagination. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardListForUserOut>> listDashboardsForUserV2(
|
|
boost::optional<utility::string_t> query,
|
|
boost::optional<utility::string_t> sort,
|
|
boost::optional<utility::string_t> order,
|
|
boost::optional<int64_t> limit,
|
|
boost::optional<int64_t> offset
|
|
) const;
|
|
/// <summary>
|
|
/// Returns a page of v2-shape dashboards for the org.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns a page of v2-shape dashboards for the org. This is the pure, user-independent list — it carries no pin state; use dashboardListForUserV2 for the personalized, pin-aware list. Supports a filter DSL (query), sort (updated_at/created_at/name), order (asc/desc), and offset-based pagination (limit/offset). Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="query">Query is the filter DSL over dashboard columns and tags, e.g. `name:cpu source:user`. Empty lists everything. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="sort">Sort is the sort field: updated_at, created_at or name. Empty sorts by updated_at. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="order">Order is the sort direction: asc or desc. Empty orders desc. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="limit">Limit caps how many dashboards come back. Zero means the default of 20; the runtime caps it at 200. (optional, default to 0L)</param>
|
|
/// <param name="offset">Offset is how many dashboards to skip for pagination. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardListOut>> listDashboardsV2(
|
|
boost::optional<utility::string_t> query,
|
|
boost::optional<utility::string_t> sort,
|
|
boost::optional<utility::string_t> order,
|
|
boost::optional<int64_t> limit,
|
|
boost::optional<int64_t> offset
|
|
) const;
|
|
/// <summary>
|
|
/// Lists all planned maintenance windows, optionally narrowed to the active ones or the recurring ones.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists all planned maintenance windows, optionally narrowed to the active ones or the recurring ones. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="active">Active, when \"true\" or \"false\", keeps only the active or inactive windows. Absent lists all. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="recurring">Recurring, when \"true\" or \"false\", keeps only the recurring or one-off windows. Absent lists all. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDowntimeSchedulesOut>> listDowntimeSchedules(
|
|
boost::optional<utility::string_t> active,
|
|
boost::optional<utility::string_t> recurring
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the available integrations and whether each is installed in the caller's org, optionally narrowed to installed or not-installed.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the available integrations and whether each is installed in the caller's org, optionally narrowed to installed or not-installed. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="isInstalled">IsInstalled, when \"true\" or \"false\", keeps only integrations in that installed state; empty lists them all. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yIntegrationsListOut>> listIntegrations(
|
|
boost::optional<utility::string_t> isInstalled
|
|
) const;
|
|
/// <summary>
|
|
/// Lists human annotations on traces and observations, optionally scoped to one review queue.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists human annotations on traces and observations, optionally scoped to one review queue. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="traceId">TraceID narrows to annotations on one trace. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="queue">Queue narrows to one review queue. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="status">Status narrows to one review status, e.g. PENDING. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="offset">Offset is how many rows to skip, for paging. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many rows come back. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMAnnotationsOut>> listLLMAnnotations(
|
|
boost::optional<utility::string_t> traceId,
|
|
boost::optional<utility::string_t> queue,
|
|
boost::optional<utility::string_t> status,
|
|
boost::optional<int64_t> offset,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists gen_ai spans as LLM observations — each an LLM call with its model, token counts, cost and latency projected from gen_ai.* attributes, newest first, over the query window.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists gen_ai spans as LLM observations — each an LLM call with its model, token counts, cost and latency projected from gen_ai.* attributes, newest first, over the query window. Callers need the viewer role; the runtime's own gate enforces it, and scopes the read to the caller's validated tenant.
|
|
/// </remarks>
|
|
/// <param name="start">Start is the start of the window as a unix-millisecond epoch. Zero means 24h before the end. (optional, default to 0L)</param>
|
|
/// <param name="end">End is the end of the window as a unix-millisecond epoch. Zero means now. (optional, default to 0L)</param>
|
|
/// <param name="traceId">TraceID narrows the view to one trace. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="sessionId">SessionID narrows the view to one conversation. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="userId">UserID narrows the view to one end user. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="name">Name narrows the view to observations of one name. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="model">Model narrows the view to one model. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="offset">Offset is how many rows to skip, for paging. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many rows come back. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMObservationsOut>> listLLMObservations(
|
|
boost::optional<int64_t> start,
|
|
boost::optional<int64_t> end,
|
|
boost::optional<utility::string_t> traceId,
|
|
boost::optional<utility::string_t> sessionId,
|
|
boost::optional<utility::string_t> userId,
|
|
boost::optional<utility::string_t> name,
|
|
boost::optional<utility::string_t> model,
|
|
boost::optional<int64_t> offset,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the LLM pricing rules for the caller's org, with pagination and an optional search and override filter.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the LLM pricing rules for the caller's org, with pagination and an optional search and override filter. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="q">Search matches rules by model or provider. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="isOverride">IsOverride, when \"true\" or \"false\", narrows to user-pinned rules or to synced ones; empty returns both. It is a string because a query param is a string on the wire, and the runtime reads absent as \"no filter\". (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="offset">Offset is how many rows to skip, for paging. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many rows come back. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMPricingRulesOut>> listLLMPricingRules(
|
|
boost::optional<utility::string_t> q,
|
|
boost::optional<utility::string_t> isOverride,
|
|
boost::optional<int64_t> offset,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists eval scores and human-feedback signals attached to traces and observations, newest first.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists eval scores and human-feedback signals attached to traces and observations, newest first. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="traceId">TraceID narrows to scores on one trace. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="observationId">ObservationID narrows to scores on one observation. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="name">Name narrows to scores of one name. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="source">Source narrows to scores from one source, e.g. API, EVAL. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="offset">Offset is how many rows to skip, for paging. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many rows come back. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMScoresOut>> listLLMScores(
|
|
boost::optional<utility::string_t> traceId,
|
|
boost::optional<utility::string_t> observationId,
|
|
boost::optional<utility::string_t> name,
|
|
boost::optional<utility::string_t> source,
|
|
boost::optional<int64_t> offset,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists conversations — gen_ai spans grouped by session.id, with their trace and observation counts, tokens and cost.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists conversations — gen_ai spans grouped by session.id, with their trace and observation counts, tokens and cost. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="start">Start is the start of the window as a unix-millisecond epoch. Zero means 24h before the end. (optional, default to 0L)</param>
|
|
/// <param name="end">End is the end of the window as a unix-millisecond epoch. Zero means now. (optional, default to 0L)</param>
|
|
/// <param name="traceId">TraceID narrows the view to one trace. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="sessionId">SessionID narrows the view to one conversation. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="userId">UserID narrows the view to one end user. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="name">Name narrows the view to observations of one name. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="model">Model narrows the view to one model. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="offset">Offset is how many rows to skip, for paging. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many rows come back. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMSessionsOut>> listLLMSessions(
|
|
boost::optional<int64_t> start,
|
|
boost::optional<int64_t> end,
|
|
boost::optional<utility::string_t> traceId,
|
|
boost::optional<utility::string_t> sessionId,
|
|
boost::optional<utility::string_t> userId,
|
|
boost::optional<utility::string_t> name,
|
|
boost::optional<utility::string_t> model,
|
|
boost::optional<int64_t> offset,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists LLM traces — gen_ai spans grouped by trace_id, with cost, tokens and latency rolled up across each trace.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists LLM traces — gen_ai spans grouped by trace_id, with cost, tokens and latency rolled up across each trace. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="start">Start is the start of the window as a unix-millisecond epoch. Zero means 24h before the end. (optional, default to 0L)</param>
|
|
/// <param name="end">End is the end of the window as a unix-millisecond epoch. Zero means now. (optional, default to 0L)</param>
|
|
/// <param name="traceId">TraceID narrows the view to one trace. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="sessionId">SessionID narrows the view to one conversation. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="userId">UserID narrows the view to one end user. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="name">Name narrows the view to observations of one name. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="model">Model narrows the view to one model. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="offset">Offset is how many rows to skip, for paging. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many rows come back. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMTracesOut>> listLLMTraces(
|
|
boost::optional<int64_t> start,
|
|
boost::optional<int64_t> end,
|
|
boost::optional<utility::string_t> traceId,
|
|
boost::optional<utility::string_t> sessionId,
|
|
boost::optional<utility::string_t> userId,
|
|
boost::optional<utility::string_t> name,
|
|
boost::optional<utility::string_t> model,
|
|
boost::optional<int64_t> offset,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists end users — gen_ai spans grouped by user.id, with their session, trace and observation counts, tokens and cost.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists end users — gen_ai spans grouped by user.id, with their session, trace and observation counts, tokens and cost. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="start">Start is the start of the window as a unix-millisecond epoch. Zero means 24h before the end. (optional, default to 0L)</param>
|
|
/// <param name="end">End is the end of the window as a unix-millisecond epoch. Zero means now. (optional, default to 0L)</param>
|
|
/// <param name="traceId">TraceID narrows the view to one trace. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="sessionId">SessionID narrows the view to one conversation. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="userId">UserID narrows the view to one end user. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="name">Name narrows the view to observations of one name. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="model">Model narrows the view to one model. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="offset">Offset is how many rows to skip, for paging. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many rows come back. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLLMUsersOut>> listLLMUsers(
|
|
boost::optional<int64_t> start,
|
|
boost::optional<int64_t> end,
|
|
boost::optional<utility::string_t> traceId,
|
|
boost::optional<utility::string_t> sessionId,
|
|
boost::optional<utility::string_t> userId,
|
|
boost::optional<utility::string_t> name,
|
|
boost::optional<utility::string_t> model,
|
|
boost::optional<int64_t> offset,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the org's metric volume-control (label reduction) rules, pageable and sortable by name, volume or recency.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the org's metric volume-control (label reduction) rules, pageable and sortable by name, volume or recency.
|
|
/// </remarks>
|
|
/// <param name="orderBy">OrderBy sorts the page: metric, ingested_volume, reduced_volume or last_updated. Unset means ingested_volume. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="order">Order is asc or desc. Unset means desc. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="search">Search narrows the page to rules whose metric name contains it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="metricName">MetricName narrows the page to one metric's rule. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="offset">Offset is how many rules to skip, for paging. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many rules come back, at most 1000. Unset means 10. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yReductionRuleListOut>> listMetricReductionRules(
|
|
boost::optional<utility::string_t> orderBy,
|
|
boost::optional<utility::string_t> order,
|
|
boost::optional<utility::string_t> search,
|
|
boost::optional<utility::string_t> metricName,
|
|
boost::optional<int64_t> offset,
|
|
boost::optional<int64_t> limit
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the distinct metric names seen in a time range, each with its description, type, unit, temporality and monotonicity.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the distinct metric names seen in a time range, each with its description, type, unit, temporality and monotonicity.
|
|
/// </remarks>
|
|
/// <param name="start">Start is the start of the window as a Unix timestamp in milliseconds. (optional, default to 0L)</param>
|
|
/// <param name="end">End is the end of the window as a Unix timestamp in milliseconds. (optional, default to 0L)</param>
|
|
/// <param name="limit">Limit caps how many metrics come back; unset means 100, at most 5000. (optional, default to 0L)</param>
|
|
/// <param name="searchText">SearchText narrows the page to metric names containing it. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="source">Source narrows the page by ingestion source. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricListOut>> listMetrics(
|
|
boost::optional<int64_t> start,
|
|
boost::optional<int64_t> end,
|
|
boost::optional<int64_t> limit,
|
|
boost::optional<utility::string_t> searchText,
|
|
boost::optional<utility::string_t> source
|
|
) const;
|
|
/// <summary>
|
|
/// Lists every org-scoped preference, each with its current and default value.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists every org-scoped preference, each with its current and default value. Admin gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yPreferencesOut>> listOrgPreferences(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists every role in the caller's org — the managed ones the platform seeds and the custom ones its admins created.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists every role in the caller's org — the managed ones the platform seeds and the custom ones its admins created.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yRolesOut>> listRoles(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists all alert rules with their current evaluation state.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists all alert rules with their current evaluation state. Viewer gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yRulesOut>> listRules(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists a service account's API keys — metadata only, never the secrets.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists a service account's API keys — metadata only, never the secrets.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAPIKeysOut>> listServiceAccountKeys(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the caller's org's service accounts.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the caller's org's service accounts.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yServiceAccountsOut>> listServiceAccounts(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the services the given provider can collect from, optionally scoped to one cloud integration.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the services the given provider can collect from, optionally scoped to one cloud integration. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="cloudIntegrationId">CloudIntegrationID, when set, scopes the listing to one cloud integration. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yServicesMetadataOut>> listServicesMetadata(
|
|
utility::string_t cloudProvider,
|
|
boost::optional<utility::string_t> cloudIntegrationId
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the caller's org's mapping groups, optionally only the enabled ones.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the caller's org's mapping groups, optionally only the enabled ones. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="enabled"> (optional, default to false)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySpanMapperGroupsOut>> listSpanMapperGroups(
|
|
boost::optional<bool> enabled
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the mappers belonging to one group, in the order they are applied.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the mappers belonging to one group, in the order they are applied. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="groupId"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySpanMappersOut>> listSpanMappers(
|
|
utility::string_t groupId
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the caller's org's funnels, each with its steps and who last touched it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the caller's org's funnels, each with its steps and who last touched it. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelsOut>> listTraceFunnels(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists every preference of the calling user, each with its current and default value.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists every preference of the calling user, each with its current and default value. Viewer gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yPreferencesOut>> listUserPreferences(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the caller's org members.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the caller's org members. Admin gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yUsersOut>> listUsers(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the org's members with their single legacy role.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the org's members with their single legacy role. Deprecated in favor of listUsers, which answers without the role. Admin gate.
|
|
/// </remarks>
|
|
pplx::task<std::shared_ptr<O11y_O11yDeprecatedUsersOut>> listUsersDeprecated(
|
|
) const;
|
|
/// <summary>
|
|
/// Locks a v2-shape dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Locks a v2-shape dashboard. Only the dashboard's creator or an org admin may lock or unlock. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<void> lockDashboardV2(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Applies an RFC 6902 JSON Patch to a v2-shape dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Applies an RFC 6902 JSON Patch to a v2-shape dashboard. The patch is applied against the postable view (metadata, spec, tags), so individual panels, queries, variables, layouts or tags can be updated without re-sending the rest. Apply is lenient — remove on a missing path is a no-op and add creates any missing parent objects — and the result is still validated. Locked dashboards are rejected. The request body is the bare JSON Patch operations array. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the dashboard id from the path.</param>
|
|
/// <param name="o11yO11yDashboardPatchIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardOut>> patchDashboardV2(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yDashboardPatchIn> o11yO11yDashboardPatchIn
|
|
) const;
|
|
/// <summary>
|
|
/// Changes a review queue's name, description or score-config set.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes a review queue's name, description or score-config set. A field the request omits is left alone. A name another queue in the same project already uses is a 409; a queue id belonging to another org is a 404.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the annotation queue to update, from the path.</param>
|
|
/// <param name="o11yUpdateQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_annQueueView>> patchO11yReviewsById(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_updateQueueIn> o11yUpdateQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Moves one queue item between PENDING and COMPLETED and sets its assignee.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Moves one queue item between PENDING and COMPLETED and sets its assignee. Completing an item stamps its completedAt. An item that exists under a different queue answers the same 404 an unknown item does, and so does a queue belonging to another org.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the annotation queue the item belongs to, from the path.</param>
|
|
/// <param name="itemId">ItemID is the item to update, from the path.</param>
|
|
/// <param name="o11yUpdateItemIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_annItemView>> patchO11yReviewsByIdItemsByItemid(
|
|
utility::string_t id,
|
|
utility::string_t itemId,
|
|
std::shared_ptr<O11y_updateItemIn> o11yUpdateItemIn
|
|
) const;
|
|
/// <summary>
|
|
/// Applies a partial update to an alert rule, by id, answering with the stored rule — the common toggle for enabling or muting a rule.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Applies a partial update to an alert rule, by id, answering with the stored rule — the common toggle for enabling or muting a rule. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="body"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRuleOut>> patchRuleByID(
|
|
utility::string_t id,
|
|
std::shared_ptr<AnyType> body
|
|
) const;
|
|
/// <summary>
|
|
/// Pins a dashboard for the calling user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Pins a dashboard for the calling user. A user can pin at most ten dashboards; pinning at the limit refuses with the runtime's conflict. Re-pinning an already-pinned dashboard is a no-op success. Pinning mutates only the caller's pin list, not the dashboard, so a viewer may pin what a viewer may read. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<void> pinDashboardV2(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Take an Alertmanager notification and page a human
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Records one Alertmanager webhook delivery and pages the on-call. Each alert prints an `ALERT-RECEIVED` line and joins the replay ring, then the batch is carried out of the process by the egress chain: the org's KMS-custodied Slack bot token first (the ONE product Slack egress, not a second webhook credential), falling back to a plain POST to `CLOUD_ALERTS_WEBHOOK_URL` — which needs no Slack connection and so works in exactly the state that silences the first. Resolved notifications page too: \"it recovered\" is the half of an incident people are actually waiting for. THE STATUS CODE REPORTS DELIVERY, NOT ARRIVAL. 200 `ok` means an egress accepted the batch. If none did — including when none is configured at all — it answers **503** naming the failure, so Alertmanager retries and counts it in `alertmanager_notifications_failed_total`. An alert nobody could be told about must never answer the same way as one that was delivered. A body that will not parse is still recorded (with empty fields) rather than rejected: the delivery happened, which is the fact being recorded, and a 400 would make Alertmanager retry a malformed payload forever. The receiver segment is Alertmanager's own receiver name, a parameter rather than a hand-listed route because the receiver set is config, not code.
|
|
/// </remarks>
|
|
/// <param name="receiver"></param>
|
|
pplx::task<void> postO11yAlertsByReceiver(
|
|
utility::string_t receiver
|
|
) const;
|
|
/// <summary>
|
|
/// Receive a Sentry envelope on the SDK's own DSN path
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Accepts an application/x-sentry-envelope frame from a Sentry SDK — the batched wire format carrying events, sessions and attachments — and ingests it against the project named in the path. THE /api/ SEGMENT IS NOT OURS TO NAME. An SDK appends its own fixed /api/<project>/envelope/ suffix to whatever DSN it is given, so this address is the SDK's, received verbatim. We receive this shape; we do not publish it. The clean spelling of the same wire is /v1/event/{project}/envelope/. AUTHENTICATED BY THE DSN PUBLIC KEY, never a Hanzo session, and therefore exempt from the principal gate: the ingest verifier checks the key in constant time, fails closed, and derives the org from it. A keyless submission is a 401 from that verifier — not a 403 from the gate, and not a 404 — which is how you tell the hops apart. The exemption is matched by method plus prefix plus suffix, never a bare prefix, so no read is reachable through it.
|
|
/// </remarks>
|
|
/// <param name="projectId"></param>
|
|
pplx::task<void> postO11yApiByProjectIdEnvelope(
|
|
utility::string_t projectId
|
|
) const;
|
|
/// <summary>
|
|
/// Receive a single Sentry event on the SDK's own DSN path
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The legacy single-event form of the envelope ingest: one JSON event rather than a framed batch, kept because SDKs in the field still send it. Same address ownership and same authentication as the envelope route — the /api/ segment is the SDK's, the DSN public key is the credential, the principal gate does not apply, and a keyless submission is a 401 from the ingest verifier.
|
|
/// </remarks>
|
|
/// <param name="projectId"></param>
|
|
pplx::task<void> postO11yApiByProjectIdStore(
|
|
utility::string_t projectId
|
|
) const;
|
|
/// <summary>
|
|
/// Reads the attribute-value request from the body rather than off the query string — the spelling the newer builder uses to send its filters alongside the request.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Reads the attribute-value request from the body rather than off the query string — the spelling the newer builder uses to send its filters alongside the request. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yFilterAttributeValueRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAttributeValuesOut>> postO11yAutoCompleteAttributeValues(
|
|
std::shared_ptr<O11y_FilterAttributeValueRequest> o11yFilterAttributeValueRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes clusters over a time range, each with its CPU and memory usage against allocatable capacity and its attributes; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes clusters over a time range, each with its CPU and memory usage against allocatable capacity and its attributes; filterable, groupable and paginated.
|
|
/// </remarks>
|
|
/// <param name="o11yClusterListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yClusterListOut>> postO11yClustersList(
|
|
std::shared_ptr<O11y_ClusterListRequest> o11yClusterListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Complete a SAML sign-in
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The assertion consumer service: the identity provider POSTs its signed assertion here, and a valid one establishes the session and answers 303 to the console. A redirect, not a value, so it is not a typed operation. UNAUTHENTICATED by necessity and authenticated in fact by the assertion's signature, which is checked against the configured provider before any session exists.
|
|
/// </remarks>
|
|
pplx::task<void> postO11yCompleteSaml(
|
|
) const;
|
|
/// <summary>
|
|
/// Counts the grouped exceptions in the query window for the caller's org.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Counts the grouped exceptions in the query window for the caller's org. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yErrorsCountIn"></param>
|
|
pplx::task<int32_t> postO11yCounterrors(
|
|
std::shared_ptr<O11y_O11yErrorsCountIn> o11yO11yErrorsCountIn
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes daemonsets over a time range, each with the CPU and memory its pods used against request and limit, desired and available node counts, restarts and attributes; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes daemonsets over a time range, each with the CPU and memory its pods used against request and limit, desired and available node counts, restarts and attributes; filterable, groupable and paginated.
|
|
/// </remarks>
|
|
/// <param name="o11yDaemonSetListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDaemonSetListOut>> postO11yDaemonsetsList(
|
|
std::shared_ptr<O11y_DaemonSetListRequest> o11yDaemonSetListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the service dependency graph over the requested window: every parent→child edge observed, with call and error rates and latency percentiles per edge.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the service dependency graph over the requested window: every parent→child edge observed, with call and error rates and latency percentiles per edge. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDependencyGraphIn"></param>
|
|
pplx::task<std::vector<std::shared_ptr<O11y_O11yDependency>>> postO11yDependencyGraph(
|
|
std::shared_ptr<O11y_O11yDependencyGraphIn> o11yO11yDependencyGraphIn
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes deployments over a time range, each with the CPU and memory its pods used against request and limit, desired and available replica counts, restarts and attributes; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes deployments over a time range, each with the CPU and memory its pods used against request and limit, desired and available replica counts, restarts and attributes; filterable, groupable and paginated.
|
|
/// </remarks>
|
|
/// <param name="o11yDeploymentListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDeploymentListOut>> postO11yDeploymentsList(
|
|
std::shared_ptr<O11y_DeploymentListRequest> o11yDeploymentListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Changes an issue's lifecycle — resolve, ignore, reopen or assign — and returns the updated issue.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes an issue's lifecycle — resolve, ignore, reopen or assign — and returns the updated issue. Fields left unset are left unchanged. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the issue id.</param>
|
|
/// <param name="o11yO11yErrorUpdateIssueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yErrorIssueOut>> postO11yErrortrackingIssuesById(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yErrorUpdateIssueIn> o11yO11yErrorUpdateIssueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Records one product-analytics event for the signed-in user — a track event with a name and free-form attributes.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Records one product-analytics event for the signed-in user — a track event with a name and free-form attributes. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yEventIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMessage>> postO11yEvent(
|
|
std::shared_ptr<O11y_O11yEventIn> o11yO11yEventIn
|
|
) const;
|
|
/// <summary>
|
|
/// Saves a new explorer view for the caller's org and returns its id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Saves a new explorer view for the caller's org and returns its id. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11ySavedView"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySavedViewCreateOut>> postO11yExplorerViews(
|
|
std::shared_ptr<O11y_SavedView> o11ySavedView
|
|
) const;
|
|
/// <summary>
|
|
/// Export raw telemetry rows as a file
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Runs a query and returns its rows as a downloadable CSV or JSONL attachment, chunked, with a trailer that says whether the export completed — so a truncated download is detectable rather than silently short. The answer is a file, not a value, which is why it is not a typed operation: the body is neither JSON nor bounded. Use the query operations when you want rows in a response. A validated, org-scoped principal is required and the export carries that principal's own tenant only.
|
|
/// </remarks>
|
|
pplx::task<void> postO11yExportRawData(
|
|
) const;
|
|
/// <summary>
|
|
/// Lists monitored hosts over a time range, each with its CPU, memory, I/O wait and 15-minute load, whether it is actively reporting, its OS and its attributes; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists monitored hosts over a time range, each with its CPU, memory, I/O wait and 15-minute load, whether it is actively reporting, its OS and its attributes; filterable, groupable and paginated. The answer also says whether any host metrics were received at all and which clusters and nodes sent them, so an empty page is distinguishable from a fleet that never reported.
|
|
/// </remarks>
|
|
/// <param name="o11yHostListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yHostListOut>> postO11yHostsList(
|
|
std::shared_ptr<O11y_HostListRequest> o11yHostListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes clusters with CPU and memory usage against allocatable capacity summed over their nodes, plus per-group node readiness and pod phase counts.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes clusters with CPU and memory usage against allocatable capacity summed over their nodes, plus per-group node readiness and pod phase counts. Rows answer as 'list' under the default k8s.cluster.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression, orderable by usage or allocatable, paginated by offset and limit.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableClusters"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraClustersOut>> postO11yInfraMonitoringClusters(
|
|
std::shared_ptr<O11y_PostableClusters> o11yPostableClusters
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes daemonsets with the CPU and memory their pods used against request and limit, the latest desired and current scheduled NODE counts (node counts, not pod counts), and per-group pod phase counts.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes daemonsets with the CPU and memory their pods used against request and limit, the latest desired and current scheduled NODE counts (node counts, not pod counts), and per-group pod phase counts. Rows answer as 'list' under the default k8s.daemonset.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression, orderable by the pod metrics or the node counts, paginated by offset and limit.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableDaemonSets"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraDaemonSetsOut>> postO11yInfraMonitoringDaemonsets(
|
|
std::shared_ptr<O11y_PostableDaemonSets> o11yPostableDaemonSets
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes deployments with the CPU and memory their pods used against request and limit, the latest desired and available replica counts, and per-group pod phase counts.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes deployments with the CPU and memory their pods used against request and limit, the latest desired and available replica counts, and per-group pod phase counts. Rows answer as 'list' under the default k8s.deployment.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression, orderable by the pod metrics or the replica counts, paginated by offset and limit.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableDeployments"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraDeploymentsOut>> postO11yInfraMonitoringDeployments(
|
|
std::shared_ptr<O11y_PostableDeployments> o11yPostableDeployments
|
|
) const;
|
|
/// <summary>
|
|
/// Lists hosts with key infrastructure metrics — CPU, memory, I/O wait and disk usage percentages and 15-minute load — plus an active/inactive status from whether the host reported in the last ten minutes.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists hosts with key infrastructure metrics — CPU, memory, I/O wait and disk usage percentages and 15-minute load — plus an active/inactive status from whether the host reported in the last ten minutes. Rows answer as 'list' under the default host.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression and by status, orderable by any of the five metrics, paginated by offset and limit.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableHosts"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraHostsOut>> postO11yInfraMonitoringHosts(
|
|
std::shared_ptr<O11y_PostableHosts> o11yPostableHosts
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes jobs with the CPU and memory their pods used against request and limit, the latest desired-successful, active, failed and successful pod counters, and per-group pod phase counts — the phase counts are current state while the counters are cumulative over the job's life.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes jobs with the CPU and memory their pods used against request and limit, the latest desired-successful, active, failed and successful pod counters, and per-group pod phase counts — the phase counts are current state while the counters are cumulative over the job's life. Rows answer as 'list' under the default k8s.job.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression, orderable by the pod metrics or the job counters, paginated by offset and limit.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableJobs"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraJobsOut>> postO11yInfraMonitoringJobs(
|
|
std::shared_ptr<O11y_PostableJobs> o11yPostableJobs
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes namespaces with the CPU and memory their pods used and per-group pod phase counts.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes namespaces with the CPU and memory their pods used and per-group pod phase counts. Rows answer as 'list' under the default k8s.namespace.name grouping or 'grouped_list' under a custom groupBy, aggregating pods either way; a metric with no data in the window answers -1. Filterable by expression, orderable by cpu or memory, paginated by offset and limit.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableNamespaces"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraNamespacesOut>> postO11yInfraMonitoringNamespaces(
|
|
std::shared_ptr<O11y_PostableNamespaces> o11yPostableNamespaces
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes nodes with CPU and memory usage against allocatable capacity, per-group readiness counts and per-group phase counts for the pods scheduled on them.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes nodes with CPU and memory usage against allocatable capacity, per-group readiness counts and per-group phase counts for the pods scheduled on them. Rows answer as 'list' under the default k8s.node.name grouping (each row one node with its readiness condition) or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression, orderable by usage or allocatable, paginated by offset and limit.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableNodes"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraNodesOut>> postO11yInfraMonitoringNodes(
|
|
std::shared_ptr<O11y_PostableNodes> o11yPostableNodes
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes pods with CPU and memory usage against request and limit, the pod's phase and its age, plus its namespace, node, owning workload and cluster attributes.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes pods with CPU and memory usage against request and limit, the pod's phase and its age, plus its namespace, node, owning workload and cluster attributes. Rows answer as 'list' under the default k8s.pod.uid grouping (each row one pod) or 'grouped_list' under a custom groupBy (each row aggregating its pods with per-phase counts); a metric with no data in the window answers -1. Filterable by expression, orderable by the six pod metrics, paginated by offset and limit.
|
|
/// </remarks>
|
|
/// <param name="o11yPostablePods"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraPodsOut>> postO11yInfraMonitoringPods(
|
|
std::shared_ptr<O11y_PostablePods> o11yPostablePods
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes persistent volume claims with available, capacity and used bytes and inode counts, plus the claim's pod, namespace, node, statefulset and cluster attributes.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes persistent volume claims with available, capacity and used bytes and inode counts, plus the claim's pod, namespace, node, statefulset and cluster attributes. Rows answer as 'list' under the default k8s.persistentvolumeclaim.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression, orderable by the six volume metrics, paginated by offset and limit.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableVolumes"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraVolumesOut>> postO11yInfraMonitoringPvcs(
|
|
std::shared_ptr<O11y_PostableVolumes> o11yPostableVolumes
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes statefulsets with the CPU and memory their pods used against request and limit, the latest desired and current replica counts, and per-group pod phase counts.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes statefulsets with the CPU and memory their pods used against request and limit, the latest desired and current replica counts, and per-group pod phase counts. Rows answer as 'list' under the default k8s.statefulset.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression, orderable by the pod metrics or the replica counts, paginated by offset and limit.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableStatefulSets"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yInfraStatefulSetsOut>> postO11yInfraMonitoringStatefulsets(
|
|
std::shared_ptr<O11y_PostableStatefulSets> o11yPostableStatefulSets
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes jobs over a time range, each with the CPU and memory its pods used against request and limit, desired-successful, active, failed and successful pod counts, restarts and attributes; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes jobs over a time range, each with the CPU and memory its pods used against request and limit, desired-successful, active, failed and successful pod counts, restarts and attributes; filterable, groupable and paginated.
|
|
/// </remarks>
|
|
/// <param name="o11yJobListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yJobListOut>> postO11yJobsList(
|
|
std::shared_ptr<O11y_JobListRequest> o11yJobListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the grouped exceptions in the query window — each an exception type with its message, count, service and first/last-seen — for the caller's org.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the grouped exceptions in the query window — each an exception type with its message, count, service and first/last-seen — for the caller's org. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yErrorsListIn"></param>
|
|
pplx::task<std::vector<std::shared_ptr<O11y_O11yListError>>> postO11yListerrors(
|
|
std::shared_ptr<O11y_O11yErrorsListIn> o11yO11yErrorsListIn
|
|
) const;
|
|
/// <summary>
|
|
/// Changes how one log field is stored — selects or deselects it as a materialized column and tunes its index — and echoes the setting back.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes how one log field is stored — selects or deselects it as a materialized column and tunes its index — and echoes the setting back. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yFieldSetting"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFieldSetting>> postO11yLogsFields(
|
|
std::shared_ptr<O11y_O11yFieldSetting> o11yO11yFieldSetting
|
|
) const;
|
|
/// <summary>
|
|
/// Saves the given log parsing pipelines as the new config version for the caller's org and starts deploying it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Saves the given log parsing pipelines as the new config version for the caller's org and starts deploying it. The set REPLACES the current one: a pipeline left out of the request is dropped from the new version, and an empty set drops them all. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yLogPipelineCreateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLogPipelinesOut>> postO11yLogsPipelines(
|
|
std::shared_ptr<O11y_O11yLogPipelineCreateIn> o11yO11yLogPipelineCreateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Runs the given log parsing pipelines over the given sample records without saving anything, and returns the transformed records plus whatever the collector logged while simulating them.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Runs the given log parsing pipelines over the given sample records without saving anything, and returns the transformed records plus whatever the collector logged while simulating them. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yLogPipelinePreviewIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLogPipelinePreviewOut>> postO11yLogsPipelinesPreview(
|
|
std::shared_ptr<O11y_O11yLogPipelinePreviewIn> o11yO11yLogPipelinePreviewIn
|
|
) const;
|
|
/// <summary>
|
|
/// Promotes and indexes log body paths: each named path is lifted out of the JSON body into its own column, with the indexes the caller asked for.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Promotes and indexes log body paths: each named path is lifted out of the JSON body into its own column, with the indexes the caller asked for. Paths must start with \"body.\". Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yLogPromotePath"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yLogPromoteOut>> postO11yLogsPromotePaths(
|
|
std::vector<std::shared_ptr<O11y_O11yLogPromotePath>> o11yO11yLogPromotePath
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the consumer side of a consumer-lag view: the consumer groups reading the topic/partition named in variables, with their throughput and latency over the window.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the consumer side of a consumer-lag view: the consumer groups reading the topic/partition named in variables, with their throughput and latency over the window.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yMessagingQueuesKafkaConsumerLagConsumerDetails(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns consumer network latency correlated per client: a throughput pass over the window finds the consumer clients, then their fetch latency joins in as a latency column per client/instance/service.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns consumer network latency correlated per client: a throughput pass over the window finds the consumer clients, then their fetch latency joins in as a latency column per client/instance/service.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yMessagingQueuesKafkaConsumerLagNetworkLatency(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the producer side of a consumer-lag view: the producers writing to the topic/partition named in variables, with their throughput and latency over the window.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the producer side of a consumer-lag view: the producers writing to the topic/partition named in variables, with their throughput and latency over the window.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yMessagingQueuesKafkaConsumerLagProducerDetails(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Checks whether the spans the Kafka consumer views need are arriving, row for row like producersOnboarding.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Checks whether the spans the Kafka consumer views need are arriving, row for row like producersOnboarding.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueueChecksOut>> postO11yMessagingQueuesKafkaOnboardingConsumers(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Checks whether Kafka's own metrics — consumer lag and partition telemetry — are arriving, so the lag views can be lit up.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Checks whether Kafka's own metrics — consumer lag and partition telemetry — are arriving, so the lag views can be lit up.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueueChecksOut>> postO11yMessagingQueuesKafkaOnboardingKafka(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Checks whether the spans the Kafka producer views need are arriving — one row per required span attribute, with a pass/fail status and, on failure, what is missing from the instrumentation.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Checks whether the spans the Kafka producer views need are arriving — one row per required span attribute, with a pass/fail status and, on failure, what is missing from the instrumentation.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueueChecksOut>> postO11yMessagingQueuesKafkaOnboardingProducers(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the consumer-group latency detail for the topic and partition named in the request's variables.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the consumer-group latency detail for the topic and partition named in the request's variables.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yMessagingQueuesKafkaPartitionLatencyConsumer(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the per-partition latency overview for the window — each topic/partition with its throughput and latency profile.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the per-partition latency overview for the window — each topic/partition with its throughput and latency profile.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yMessagingQueuesKafkaPartitionLatencyOverview(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Correlates producer and consumer spans over the evaluation window (eval_time bounds the scan) and returns the pairings with their end-to-end delay — the check that messages produced are being consumed.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Correlates producer and consumer spans over the evaluation window (eval_time bounds the scan) and returns the pairings with their end-to-end delay — the check that messages produced are being consumed.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yMessagingQueuesKafkaSpanEvaluation(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the consumer topic-throughput overview for the window — what each consumer group read, per topic.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the consumer topic-throughput overview for the window — what each consumer group read, per topic.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yMessagingQueuesKafkaTopicThroughputConsumer(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Breaks one consumer topic's throughput down using the topic and service named in variables.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Breaks one consumer topic's throughput down using the topic and service named in variables.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yMessagingQueuesKafkaTopicThroughputConsumerDetails(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns the producer topic-throughput overview for the window — what each producer service wrote, per topic.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns the producer topic-throughput overview for the window — what each producer service wrote, per topic.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yMessagingQueuesKafkaTopicThroughputProducer(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Breaks one producer topic's throughput down using the topic and service named in variables.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Breaks one producer topic's throughput down using the topic and service named in variables.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yMessagingQueuesKafkaTopicThroughputProducerDetails(
|
|
std::shared_ptr<O11y_O11yQueueIn> o11yO11yQueueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the messaging destinations observed in the window — one row per queue/destination/service combination with its throughput and latency columns.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the messaging destinations observed in the window — one row per queue/destination/service combination with its throughput and latency columns. Filters narrow by queue system, destination, service or any span attribute.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueueListIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueueRowsOut>> postO11yMessagingQueuesQueueOverview(
|
|
std::shared_ptr<O11y_O11yQueueListIn> o11yO11yQueueListIn
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes namespaces over a time range, each with the CPU and memory its pods used, their phase counts and its attributes; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes namespaces over a time range, each with the CPU and memory its pods used, their phase counts and its attributes; filterable, groupable and paginated.
|
|
/// </remarks>
|
|
/// <param name="o11yNamespaceListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yNamespaceListOut>> postO11yNamespacesList(
|
|
std::shared_ptr<O11y_NamespaceListRequest> o11yNamespaceListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes nodes over a time range, each with its CPU and memory usage against allocatable capacity, readiness condition counts and attributes; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes nodes over a time range, each with its CPU and memory usage against allocatable capacity, readiness condition counts and attributes; filterable, groupable and paginated.
|
|
/// </remarks>
|
|
/// <param name="o11yNodeListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yNodeListOut>> postO11yNodesList(
|
|
std::shared_ptr<O11y_NodeListRequest> o11yNodeListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes pods over a time range, each with its CPU and memory usage against request and limit, restart count, phase counts and attributes; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes pods over a time range, each with its CPU and memory usage against request and limit, restart count, phase counts and attributes; filterable, groupable and paginated.
|
|
/// </remarks>
|
|
/// <param name="o11yPodListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yPodListOut>> postO11yPodsList(
|
|
std::shared_ptr<O11y_PodListRequest> o11yPodListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Lists monitored processes over a time range, each with its name, PID, command line and CPU and memory usage; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists monitored processes over a time range, each with its name, PID, command line and CPU and memory usage; filterable, groupable and paginated.
|
|
/// </remarks>
|
|
/// <param name="o11yProcessListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yProcessListOut>> postO11yProcessesList(
|
|
std::shared_ptr<O11y_ProcessListRequest> o11yProcessListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes persistent volume claims over a time range, each with its available, capacity and used bytes, inode counts and attributes; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes persistent volume claims over a time range, each with its available, capacity and used bytes, inode counts and attributes; filterable, groupable and paginated.
|
|
/// </remarks>
|
|
/// <param name="o11yVolumeListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yPvcListOut>> postO11yPvcsList(
|
|
std::shared_ptr<O11y_VolumeListRequest> o11yVolumeListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Analyzes a query and extracts the metric names it reads and the columns it groups by.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Analyzes a query and extracts the metric names it reads and the columns it groups by. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yAnalyzeIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAnalyzeOut>> postO11yQueryFilterAnalyze(
|
|
std::shared_ptr<O11y_O11yAnalyzeIn> o11yO11yAnalyzeIn
|
|
) const;
|
|
/// <summary>
|
|
/// Executes a composite query over a time range: builder queries over traces, logs and metrics, formulas, trace operators, PromQL and Datastore SQL, answering time series, scalars or raw records as the request type asks.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Executes a composite query over a time range: builder queries over traces, logs and metrics, formulas, trace operators, PromQL and Datastore SQL, answering time series, scalars or raw records as the request type asks. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yQueryRangeRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeOut>> postO11yQueryRange(
|
|
std::shared_ptr<O11y_QueryRangeRequest> o11yQueryRangeRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Parses a builder query and echoes it back normalized to the v3 shape — the endpoint the UI uses to canonicalize a query without running it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Parses a builder query and echoes it back normalized to the v3 shape — the endpoint the UI uses to canonicalize a query without running it. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yQueryRangeParamsV3"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangeFormatOut>> postO11yQueryRangeFormat(
|
|
std::shared_ptr<O11y_QueryRangeParamsV3> o11yQueryRangeParamsV3
|
|
) const;
|
|
/// <summary>
|
|
/// Validates a composite query and renders the Datastore statements it would run WITHOUT executing it — a dry run for agentic and tooling use.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Validates a composite query and renders the Datastore statements it would run WITHOUT executing it — a dry run for agentic and tooling use. verbose=false trades the rendered SQL and EXPLAIN for a lightweight per-query verdict. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yQueryRangePreviewIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yQueryRangePreviewOut>> postO11yQueryRangePreview(
|
|
std::shared_ptr<O11y_O11yQueryRangePreviewIn> o11yO11yQueryRangePreviewIn
|
|
) const;
|
|
/// <summary>
|
|
/// Creates the FIRST organization and its admin user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates the FIRST organization and its admin user. It is open by design — there is nobody to be signed in as yet — and refuses once setup has completed, after which new users arrive by invitation only. Open by design; the runtime's own gate is OpenAccess.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yRegisterIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRegisterOut>> postO11yRegister(
|
|
std::shared_ptr<O11y_O11yRegisterIn> o11yO11yRegisterIn
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a human-review queue in the caller's org and project.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a human-review queue in the caller's org and project. A name already used by another queue in the same project is a 409.
|
|
/// </remarks>
|
|
/// <param name="o11yCreateQueueReq"></param>
|
|
pplx::task<std::shared_ptr<O11y_annQueueView>> postO11yReviews(
|
|
std::shared_ptr<O11y_createQueueReq> o11yCreateQueueReq
|
|
) const;
|
|
/// <summary>
|
|
/// Enqueues traces, observations or sessions on a review queue.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Enqueues traces, observations or sessions on a review queue. Each item names exactly one object, either by traceId / observationId / sessionId or by objectType plus objectId; every item enters PENDING. A queue id belonging to another org is a 404.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the annotation queue to add to, from the path.</param>
|
|
/// <param name="o11yAddItemsIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_annItemsCreated>> postO11yReviewsByIdItems(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_addItemsIn> o11yAddItemsIn
|
|
) const;
|
|
/// <summary>
|
|
/// Aggregates a project's captured errors into a table — the caller names the filters, the groupings and the aggregations, and gets back the columns and rows they asked for.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Aggregates a project's captured errors into a table — the caller names the filters, the groupings and the aggregations, and gets back the columns and rows they asked for. The project is mandatory and is checked against the caller's own org before it scopes anything, so a project id belonging to someone else reads as absent rather than as data.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDiscoverIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDiscoverOut>> postO11ySentinelDiscover(
|
|
std::shared_ptr<O11y_O11yDiscoverIn> o11yO11yDiscoverIn
|
|
) const;
|
|
/// <summary>
|
|
/// Creates a Sentry project under the caller's org and returns it, DSN included.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a Sentry project under the caller's org and returns it, DSN included. Only the name, and optionally a slug and platform, are the caller's to set; the org, id and key are server-assigned. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11ySentryPostableProject"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySentryProjectOut>> postO11ySentinelProjects(
|
|
std::shared_ptr<O11y_O11ySentryPostableProject> o11yO11ySentryPostableProject
|
|
) const;
|
|
/// <summary>
|
|
/// Rotates a project's DSN key — bumping its rotation watermark so keys below it stop verifying — and returns the project with its new DSN.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Rotates a project's DSN key — bumping its rotation watermark so keys below it stop verifying — and returns the project with its new DSN. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the project id.</param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySentryProjectOut>> postO11ySentinelProjectsByIdKeysRotate(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one service's entry-point operations with the same latency and error profile topOperations reports.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one service's entry-point operations with the same latency and error profile topOperations reports.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yOperationsIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yOperationsOut>> postO11yServiceEntryPointOperations(
|
|
std::shared_ptr<O11y_O11yOperationsIn> o11yO11yOperationsIn
|
|
) const;
|
|
/// <summary>
|
|
/// Maps each service to its entry-point span names — for the one service named in the request, or for every service when none is.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Maps each service to its entry-point span names — for the one service named in the request, or for every service when none is.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yTopLevelOpsIn"></param>
|
|
pplx::task<std::map<utility::string_t, std::vector<utility::string_t>>> postO11yServiceTopLevelOperations(
|
|
std::shared_ptr<O11y_O11yTopLevelOpsIn> o11yO11yTopLevelOpsIn
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one service's heaviest operations in the window, each with p50/p95/p99 latency, how often it ran and how often it errored.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one service's heaviest operations in the window, each with p50/p95/p99 latency, how often it ran and how often it errored.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yOperationsIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yOperationsOut>> postO11yServiceTopOperations(
|
|
std::shared_ptr<O11y_O11yOperationsIn> o11yO11yOperationsIn
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the instrumented services seen in the window, each with the request profile of its entry-point spans: p99 and average latency, call and error rates, and the entry-point operations the numbers were computed over.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the instrumented services seen in the window, each with the request profile of its entry-point spans: p99 and average latency, call and error rates, and the entry-point operations the numbers were computed over.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yServicesIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yServicesOut>> postO11yServices(
|
|
std::shared_ptr<O11y_O11yServicesIn> o11yO11yServicesIn
|
|
) const;
|
|
/// <summary>
|
|
/// Sets one service's apdex threshold and the status codes excluded from its score.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Sets one service's apdex threshold and the status codes excluded from its score. Admin only, as the mux tree has always gated it (AdminAccess); the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yApdexSetIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yApdexSetOut>> postO11ySettingsApdex(
|
|
std::shared_ptr<O11y_O11yApdexSetIn> o11yO11yApdexSetIn
|
|
) const;
|
|
/// <summary>
|
|
/// Sets the org's retention policy for one signal: the default TTL in days, ordered per-label retention rules, and optional cold-storage settings.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Sets the org's retention policy for one signal: the default TTL in days, ordered per-label retention rules, and optional cold-storage settings. Admin only, as the mux tree has always gated it (AdminAccess); the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yRetentionSetIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRetentionSetOut>> postO11ySettingsTtl(
|
|
std::shared_ptr<O11y_O11yRetentionSetIn> o11yO11yRetentionSetIn
|
|
) const;
|
|
/// <summary>
|
|
/// Places one span's duration among its peers: the p50/p90/p99 durations of like spans, and the percentile the given duration lands at.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Places one span's duration among its peers: the p50/p90/p99 durations of like spans, and the percentile the given duration lands at. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11ySpanPercentileIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySpanPercentileOut>> postO11ySpanPercentile(
|
|
std::shared_ptr<O11y_O11ySpanPercentileIn> o11yO11ySpanPercentileIn
|
|
) const;
|
|
/// <summary>
|
|
/// Lists Kubernetes statefulsets over a time range, each with the CPU and memory its pods used against request and limit, desired and available replica counts, restarts and attributes; filterable, groupable and paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists Kubernetes statefulsets over a time range, each with the CPU and memory its pods used against request and limit, desired and available replica counts, restarts and attributes; filterable, groupable and paginated.
|
|
/// </remarks>
|
|
/// <param name="o11yStatefulSetListRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yStatefulSetListOut>> postO11yStatefulsetsList(
|
|
std::shared_ptr<O11y_StatefulSetListRequest> o11yStatefulSetListRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Substitutes a query's variables and returns the resolved request, without running it — what a dashboard does before it queries.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Substitutes a query's variables and returns the resolved request, without running it — what a dashboard does before it queries. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yQueryRangeRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySubstituteVarsOut>> postO11ySubstituteVars(
|
|
std::shared_ptr<O11y_QueryRangeRequest> o11yQueryRangeRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one external domain's endpoint-level breakdown — each endpoint with its rate, error and latency columns over the window.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one external domain's endpoint-level breakdown — each endpoint with its rate, error and latency columns over the window.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDomainsIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDomainsOut>> postO11yThirdPartyApisOverviewDomain(
|
|
std::shared_ptr<O11y_O11yDomainsIn> o11yO11yDomainsIn
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the external domains the instrumented services call, with request rate, error percentage and latency per domain.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the external domains the instrumented services call, with request rate, error percentage and latency per domain. Rows whose domain is a bare IP address are dropped unless show_ip asks for them.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDomainsIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDomainsOut>> postO11yThirdPartyApisOverviewList(
|
|
std::shared_ptr<O11y_O11yDomainsIn> o11yO11yDomainsIn
|
|
) const;
|
|
/// <summary>
|
|
/// Evaluates a dashboard variable query and returns the values the variable may take.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Evaluates a dashboard variable query and returns the values the variable may take. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDashboardVarsIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardVarsOut>> postO11yVariablesQuery(
|
|
std::shared_ptr<O11y_O11yDashboardVarsIn> o11yO11yDashboardVarsIn
|
|
) const;
|
|
/// <summary>
|
|
/// Estimates the series reduction and the dashboards and alerts a candidate volume-control rule would touch, without persisting it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Estimates the series reduction and the dashboards and alerts a candidate volume-control rule would touch, without persisting it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yReductionRulePreviewIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yReductionRulePreviewOut>> previewMetricReductionRule(
|
|
std::shared_ptr<O11y_O11yReductionRulePreviewIn> o11yO11yReductionRulePreviewIn
|
|
) const;
|
|
/// <summary>
|
|
/// Records the deployment's host in Zeus, overwriting any prior one.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Records the deployment's host in Zeus, overwriting any prior one. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableHost"></param>
|
|
pplx::task<void> putHost(
|
|
std::shared_ptr<O11y_PostableHost> o11yPostableHost
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces one saved explorer view by id with the given view and echoes it back.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces one saved explorer view by id with the given view and echoes it back. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="viewId">ViewID is the id of the view to replace, taken from the URL.</param>
|
|
/// <param name="o11yO11ySavedViewUpdateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11ySavedViewOut>> putO11yExplorerViewsByViewid(
|
|
utility::string_t viewId,
|
|
std::shared_ptr<O11y_O11ySavedViewUpdateIn> o11yO11ySavedViewUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Changes an issue's lifecycle — resolve, ignore, reopen or assign — and returns the updated issue.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes an issue's lifecycle — resolve, ignore, reopen or assign — and returns the updated issue. Fields left unset are left unchanged. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the issue id.</param>
|
|
/// <param name="o11yO11ySentryUpdateIssueIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yErrorIssueOut>> putO11ySentinelIssuesById(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11ySentryUpdateIssueIn> o11yO11ySentryUpdateIssueIn
|
|
) const;
|
|
/// <summary>
|
|
/// Records the deployment's profile in Zeus — how the team uses observability today and what they plan — overwriting any prior one.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Records the deployment's profile in Zeus — how the team uses observability today and what they plan — overwriting any prior one. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="o11yPostableProfile"></param>
|
|
pplx::task<void> putProfile(
|
|
std::shared_ptr<O11y_PostableProfile> o11yPostableProfile
|
|
) const;
|
|
/// <summary>
|
|
/// Takes a role away from one org member, by user id and role id — someone else, never the caller.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Takes a role away from one org member, by user id and role id — someone else, never the caller. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="roleId"></param>
|
|
pplx::task<void> removeUserRoleByUserIDAndRoleID(
|
|
utility::string_t id,
|
|
utility::string_t roleId
|
|
) const;
|
|
/// <summary>
|
|
/// Sets a new password for whoever the reset token was minted for, consuming the token.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Sets a new password for whoever the reset token was minted for, consuming the token. Unauthenticated: the token is the proof.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yResetPasswordIn"></param>
|
|
pplx::task<void> resetPassword(
|
|
std::shared_ptr<O11y_O11yResetPasswordIn> o11yO11yResetPasswordIn
|
|
) const;
|
|
/// <summary>
|
|
/// Revokes an API key.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Revokes an API key. Revocation is immediate and permanent.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="fid"></param>
|
|
pplx::task<void> revokeServiceAccountKey(
|
|
utility::string_t id,
|
|
utility::string_t fid
|
|
) const;
|
|
/// <summary>
|
|
/// Exchanges a refresh token for a fresh token pair, retiring the old pair.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Exchanges a refresh token for a fresh token pair, retiring the old pair. The access token being rotated identifies the session.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yRotateSessionIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yTokenOut>> rotateSession(
|
|
std::shared_ptr<O11y_O11yRotateSessionIn> o11yO11yRotateSessionIn
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the workspace's ingestion keys whose name matches the search, paginated.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the workspace's ingestion keys whose name matches the search, paginated. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="name">Name is the substring to match ingestion-key names against. (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="page">Page is the 1-based page number. (optional, default to 0L)</param>
|
|
/// <param name="perPage">PerPage is the page size. (optional, default to 0L)</param>
|
|
pplx::task<std::shared_ptr<O11y_O11yIngestionKeysOut>> searchIngestionKeys(
|
|
boost::optional<utility::string_t> name,
|
|
boost::optional<int64_t> page,
|
|
boost::optional<int64_t> perPage
|
|
) const;
|
|
/// <summary>
|
|
/// Returns one trace's spans as a column/row table, optionally centred on a span and walked a fixed number of levels up and down from it — the read the trace explorer opens a trace with.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Returns one trace's spans as a column/row table, optionally centred on a span and walked a fixed number of levels up and down from it — the read the trace explorer opens a trace with. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="traceId"></param>
|
|
/// <param name="spanId"> (optional, default to utility::conversions::to_string_t(""))</param>
|
|
/// <param name="levelUp"> (optional, default to 0L)</param>
|
|
/// <param name="levelDown"> (optional, default to 0L)</param>
|
|
/// <param name="spanRenderLimit"> (optional, default to 0L)</param>
|
|
pplx::task<std::vector<std::shared_ptr<O11y_O11yTraceSpanWindow>>> searchTraces(
|
|
utility::string_t traceId,
|
|
boost::optional<utility::string_t> spanId,
|
|
boost::optional<int64_t> levelUp,
|
|
boost::optional<int64_t> levelDown,
|
|
boost::optional<int64_t> spanRenderLimit
|
|
) const;
|
|
/// <summary>
|
|
/// Assigns a role, by role name, to one org member — someone else, never the caller.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Assigns a role, by role name, to one org member — someone else, never the caller. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11ySetRoleIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yAck>> setRoleByUserID(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11ySetRoleIn> o11yO11ySetRoleIn
|
|
) const;
|
|
/// <summary>
|
|
/// Sends a test notification to the posted receiver.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Sends a test notification to the posted receiver. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="o11yAlertmanagertypesReceiver"></param>
|
|
pplx::task<void> testChannel(
|
|
std::shared_ptr<O11y_alertmanagertypes_Receiver> o11yAlertmanagertypesReceiver
|
|
) const;
|
|
/// <summary>
|
|
/// Sends a test notification to the posted receiver.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Sends a test notification to the posted receiver. The legacy path; prefer /channels/test. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="o11yAlertmanagertypesReceiver"></param>
|
|
pplx::task<void> testChannelDeprecated(
|
|
std::shared_ptr<O11y_alertmanagertypes_Receiver> o11yAlertmanagertypesReceiver
|
|
) const;
|
|
/// <summary>
|
|
/// Fires a test notification for a rule definition without saving it, answering with how many series would alert.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Fires a test notification for a rule definition without saving it, answering with how many series would alert. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="body"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yTestRuleOut>> testRule(
|
|
std::shared_ptr<AnyType> body
|
|
) const;
|
|
/// <summary>
|
|
/// Fires a test notification for the posted rule definition and answers with how many series alerted and a status message.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Fires a test notification for the posted rule definition and answers with how many series alerted and a status message. The legacy path; prefer /rules/test. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="body"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yTestNotificationOut>> testRuleNotification(
|
|
std::shared_ptr<AnyType> body
|
|
) const;
|
|
/// <summary>
|
|
/// Removes an integration from the caller's org by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes an integration from the caller's org by id. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="o11yUninstallIntegrationRequest"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yIntegrationAck>> uninstallIntegration(
|
|
std::shared_ptr<O11y_UninstallIntegrationRequest> o11yUninstallIntegrationRequest
|
|
) const;
|
|
/// <summary>
|
|
/// Unlocks a v2-shape dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Unlocks a v2-shape dashboard. Only the dashboard's creator or an org admin may lock or unlock. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<void> unlockDashboardV2(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Removes the caller's pin for a dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Removes the caller's pin for a dashboard. Idempotent — unpinning a dashboard that was not pinned still succeeds. Callers need the viewer role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the resource id from the path.</param>
|
|
pplx::task<void> unpinDashboardV2(
|
|
utility::string_t id
|
|
) const;
|
|
/// <summary>
|
|
/// Changes a connected account's configuration for the given provider, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes a connected account's configuration for the given provider, by id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yUpdateAccountIn"></param>
|
|
pplx::task<void> updateAccount(
|
|
utility::string_t cloudProvider,
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yUpdateAccountIn> o11yO11yUpdateAccountIn
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces one auth domain's SSO configuration, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces one auth domain's SSO configuration, by id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yUpdatableAuthDomain"></param>
|
|
pplx::task<void> updateAuthDomain(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yUpdatableAuthDomain> o11yO11yUpdatableAuthDomain
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces a notification channel's receiver, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces a notification channel's receiver, by id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yChannelUpdateIn"></param>
|
|
pplx::task<void> updateChannelByID(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yChannelUpdateIn> o11yO11yChannelUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Updates a v2-shape dashboard's metadata, spec and tag set.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Updates a v2-shape dashboard's metadata, spec and tag set. The name is immutable and locked dashboards are rejected. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the dashboard id from the path.</param>
|
|
/// <param name="o11yO11yDashboardUpdateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardOut>> updateDashboardV2(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yDashboardUpdateIn> o11yO11yDashboardUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces a saved view's name and data.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces a saved view's name and data. Saved views are shared org-wide. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the saved view id from the path.</param>
|
|
/// <param name="o11yO11yDashboardViewUpdateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDashboardViewOut>> updateDashboardView(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yDashboardViewUpdateIn> o11yO11yDashboardViewUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces a planned maintenance window, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces a planned maintenance window, by id. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yDowntimeUpdateIn"></param>
|
|
pplx::task<void> updateDowntimeScheduleByID(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yDowntimeUpdateIn> o11yO11yDowntimeUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Changes an ingestion key, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes an ingestion key, by id. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="keyId"></param>
|
|
/// <param name="o11yO11yUpdateIngestionKeyIn"></param>
|
|
pplx::task<void> updateIngestionKey(
|
|
utility::string_t keyId,
|
|
std::shared_ptr<O11y_O11yUpdateIngestionKeyIn> o11yO11yUpdateIngestionKeyIn
|
|
) const;
|
|
/// <summary>
|
|
/// Changes an ingestion key limit, by limit id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes an ingestion key limit, by limit id. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="limitId"></param>
|
|
/// <param name="o11yO11yUpdateLimitIn"></param>
|
|
pplx::task<void> updateIngestionKeyLimit(
|
|
utility::string_t limitId,
|
|
std::shared_ptr<O11y_O11yUpdateLimitIn> o11yO11yUpdateLimitIn
|
|
) const;
|
|
/// <summary>
|
|
/// Updates one metric's metadata — description, type, unit, temporality, monotonicity — and answers with the bare success envelope.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Updates one metric's metadata — description, type, unit, temporality, monotonicity — and answers with the bare success envelope.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yMetricMetadataSaveIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yMetricAckOut>> updateMetricMetadata(
|
|
std::shared_ptr<O11y_O11yMetricMetadataSaveIn> o11yO11yMetricMetadataSaveIn
|
|
) const;
|
|
/// <summary>
|
|
/// Updates the match type and labels of a volume-control rule by its id; the metric name is immutable.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Updates the match type and labels of a volume-control rule by its id; the metric name is immutable.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the rule's id.</param>
|
|
/// <param name="o11yO11yReductionRuleSaveIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yReductionRuleOut>> updateMetricReductionRuleByID(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yReductionRuleSaveIn> o11yO11yReductionRuleSaveIn
|
|
) const;
|
|
/// <summary>
|
|
/// Rewrites the caller's own organization record — display name, name, alias — always addressed as \"me\", never by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Rewrites the caller's own organization record — display name, name, alias — always addressed as \"me\", never by id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yOrganization"></param>
|
|
pplx::task<void> updateMyOrganization(
|
|
std::shared_ptr<O11y_O11yOrganization> o11yO11yOrganization
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces the calling user's password, refusing when the old one does not match.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces the calling user's password, refusing when the old one does not match. Open to any authenticated caller.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yChangePasswordIn"></param>
|
|
pplx::task<void> updateMyPassword(
|
|
std::shared_ptr<O11y_O11yChangePasswordIn> o11yO11yChangePasswordIn
|
|
) const;
|
|
/// <summary>
|
|
/// Renames the calling service account.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Renames the calling service account.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yMyServiceAccountUpdateIn"></param>
|
|
pplx::task<void> updateMyServiceAccount(
|
|
std::shared_ptr<O11y_O11yMyServiceAccountUpdateIn> o11yO11yMyServiceAccountUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Renames the calling user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Renames the calling user. Open to any authenticated caller.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yUpdatableUser"></param>
|
|
pplx::task<void> updateMyUserV2(
|
|
std::shared_ptr<O11y_O11yUpdatableUser> o11yO11yUpdatableUser
|
|
) const;
|
|
/// <summary>
|
|
/// Sets one org-scoped preference, by name.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Sets one org-scoped preference, by name. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="name"></param>
|
|
/// <param name="o11yO11yUpdatablePreference"></param>
|
|
pplx::task<void> updateOrgPreference(
|
|
utility::string_t name,
|
|
std::shared_ptr<O11y_O11yUpdatablePreference> o11yO11yUpdatablePreference
|
|
) const;
|
|
/// <summary>
|
|
/// Updates the public-sharing config for a dashboard.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Updates the public-sharing config for a dashboard. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="id">ID is the dashboard id from the path.</param>
|
|
/// <param name="o11yO11yPublicDashboardWriteIn"></param>
|
|
pplx::task<void> updatePublicDashboard(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yPublicDashboardWriteIn> o11yO11yPublicDashboardWriteIn
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces the org's quick filters for one signal with the attribute list given.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces the org's quick filters for one signal with the attribute list given. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yUpdatableQuickFilters"></param>
|
|
pplx::task<void> updateQuickFilters(
|
|
std::shared_ptr<O11y_O11yUpdatableQuickFilters> o11yO11yUpdatableQuickFilters
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces a custom role's description and transaction groups.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces a custom role's description and transaction groups. Both fields are mandatory — send an empty string or an empty array to clear one — and managed roles cannot be edited.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yRoleUpdateIn"></param>
|
|
pplx::task<void> updateRole(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yRoleUpdateIn> o11yO11yRoleUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces a route policy, by id, answering with the stored policy.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces a route policy, by id, answering with the stored policy. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yRoutePolicyUpdateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yRoutePolicyOut>> updateRoutePolicy(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yRoutePolicyUpdateIn> o11yO11yRoutePolicyUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces an alert rule's definition, by id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces an alert rule's definition, by id. Editor gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="body"></param>
|
|
pplx::task<void> updateRuleByID(
|
|
utility::string_t id,
|
|
std::shared_ptr<AnyType> body
|
|
) const;
|
|
/// <summary>
|
|
/// Changes a service's configuration for one connected account of the given provider, by account id and service id.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes a service's configuration for one connected account of the given provider, by account id and service id. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="cloudProvider"></param>
|
|
/// <param name="id"></param>
|
|
/// <param name="serviceId"></param>
|
|
/// <param name="o11yO11yUpdateServiceIn"></param>
|
|
pplx::task<void> updateService(
|
|
utility::string_t cloudProvider,
|
|
utility::string_t id,
|
|
utility::string_t serviceId,
|
|
std::shared_ptr<O11y_O11yUpdateServiceIn> o11yO11yUpdateServiceIn
|
|
) const;
|
|
/// <summary>
|
|
/// Renames a service account.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Renames a service account.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yServiceAccountUpdateIn"></param>
|
|
pplx::task<void> updateServiceAccount(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yServiceAccountUpdateIn> o11yO11yServiceAccountUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Renames an API key or moves its expiry.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Renames an API key or moves its expiry.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="fid"></param>
|
|
/// <param name="o11yO11yAPIKeyUpdateIn"></param>
|
|
pplx::task<void> updateServiceAccountKey(
|
|
utility::string_t id,
|
|
utility::string_t fid,
|
|
std::shared_ptr<O11y_O11yAPIKeyUpdateIn> o11yO11yAPIKeyUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Changes a mapper's field context, config or enabled state.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes a mapper's field context, config or enabled state. Every field is optional and only the ones sent are applied. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="groupId"></param>
|
|
/// <param name="mapperId"></param>
|
|
/// <param name="o11yO11ySpanMapperUpdateIn"></param>
|
|
pplx::task<void> updateSpanMapper(
|
|
utility::string_t groupId,
|
|
utility::string_t mapperId,
|
|
std::shared_ptr<O11y_O11ySpanMapperUpdateIn> o11yO11ySpanMapperUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Changes a group's name, condition or enabled state.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes a group's name, condition or enabled state. Every field is optional and only the ones sent are applied. Callers need the admin role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="groupId"></param>
|
|
/// <param name="o11yO11ySpanMapperGroupUpdateIn"></param>
|
|
pplx::task<void> updateSpanMapperGroup(
|
|
utility::string_t groupId,
|
|
std::shared_ptr<O11y_O11ySpanMapperGroupUpdateIn> o11yO11ySpanMapperGroupUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Changes how one span field is stored — selects or deselects it as a materialized column and tunes its index — and echoes the setting back.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Changes how one span field is stored — selects or deselects it as a materialized column and tunes its index — and echoes the setting back. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yFieldSetting"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFieldSetting>> updateTraceField(
|
|
std::shared_ptr<O11y_O11yFieldSetting> o11yO11yFieldSetting
|
|
) const;
|
|
/// <summary>
|
|
/// Renames a funnel or rewrites its description, answering the funnel as it now stands.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Renames a funnel or rewrites its description, answering the funnel as it now stands. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="funnelId"></param>
|
|
/// <param name="o11yO11yFunnelUpdateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelOut>> updateTraceFunnel(
|
|
utility::string_t funnelId,
|
|
std::shared_ptr<O11y_O11yFunnelUpdateIn> o11yO11yFunnelUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Replaces a funnel's steps — the funnel is named in the body rather than the path — and answers the funnel as it now stands.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Replaces a funnel's steps — the funnel is named in the body rather than the path — and answers the funnel as it now stands. A name or description sent alongside is applied too; an empty one leaves it as it was. Callers need the editor role; the runtime's own gate enforces it.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yFunnelStepsUpdateIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelOut>> updateTraceFunnelSteps(
|
|
std::shared_ptr<O11y_O11yFunnelStepsUpdateIn> o11yO11yFunnelStepsUpdateIn
|
|
) const;
|
|
/// <summary>
|
|
/// Renames one org member, by user id — someone else, never the caller, who renames themselves through updateMyUser.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Renames one org member, by user id — someone else, never the caller, who renames themselves through updateMyUser. Admin gate.
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yUserUpdate"></param>
|
|
pplx::task<void> updateUser(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yUserUpdate> o11yO11yUserUpdate
|
|
) const;
|
|
/// <summary>
|
|
/// Renames one org member and may move their legacy role, answering with the updated record.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Renames one org member and may move their legacy role, answering with the updated record. Admins may update anyone; a non-admin only themselves (the runtime's self-access gate).
|
|
/// </remarks>
|
|
/// <param name="id"></param>
|
|
/// <param name="o11yO11yDeprecatedUserUpdate"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yDeprecatedUserOut>> updateUserDeprecated(
|
|
utility::string_t id,
|
|
std::shared_ptr<O11y_O11yDeprecatedUserUpdate> o11yO11yDeprecatedUserUpdate
|
|
) const;
|
|
/// <summary>
|
|
/// Sets one preference of the calling user, by name.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Sets one preference of the calling user, by name. Viewer gate.
|
|
/// </remarks>
|
|
/// <param name="name"></param>
|
|
/// <param name="o11yO11yUpdatablePreference"></param>
|
|
pplx::task<void> updateUserPreference(
|
|
utility::string_t name,
|
|
std::shared_ptr<O11y_O11yUpdatablePreference> o11yO11yUpdatablePreference
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the traces that match a funnel described inline — the builder's \"try this\" before anything is saved.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the traces that match a funnel described inline — the builder's \"try this\" before anything is saved.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yDraftFunnelIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> validateDraftFunnelTraces(
|
|
std::shared_ptr<O11y_O11yDraftFunnelIn> o11yO11yDraftFunnelIn
|
|
) const;
|
|
/// <summary>
|
|
/// Lists the traces that match a saved funnel over a window — the read that answers \"is this funnel finding anything at all\".
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Lists the traces that match a saved funnel over a window — the read that answers \"is this funnel finding anything at all\".
|
|
/// </remarks>
|
|
/// <param name="funnelId"></param>
|
|
/// <param name="o11yO11yFunnelWindowIn"></param>
|
|
pplx::task<std::shared_ptr<O11y_O11yFunnelRowsOut>> validateTraceFunnelTraces(
|
|
utility::string_t funnelId,
|
|
std::shared_ptr<O11y_O11yFunnelWindowIn> o11yO11yFunnelWindowIn
|
|
) const;
|
|
/// <summary>
|
|
/// Checks that a reset-password token exists and has not expired, without consuming it.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Checks that a reset-password token exists and has not expired, without consuming it. Unauthenticated: the token is the proof.
|
|
/// </remarks>
|
|
/// <param name="o11yO11yResetTokenRef"></param>
|
|
pplx::task<void> verifyResetPasswordToken(
|
|
std::shared_ptr<O11y_O11yResetTokenRef> o11yO11yResetTokenRef
|
|
) const;
|
|
|
|
protected:
|
|
std::shared_ptr<const ApiClient> m_ApiClient;
|
|
};
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_API_O11yApi_H_ */
|
|
|