Files
google-apis-rs/google_monitoring3_cli/projects_metric-descriptors-create/index.html
2024-03-05 21:06:01 +01:00

432 lines
25 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-monitoring3-cli/projects_metric-descriptors-create/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Metric Descriptors Create - Monitoring v5.0.4+20240225</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Metric Descriptors Create";
var mkdocs_page_input_path = "projects_metric-descriptors-create.md";
var mkdocs_page_url = "/google-apis-rs/google-monitoring3-cli/projects_metric-descriptors-create/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Monitoring v5.0.4+20240225
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Folders</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../folders_time-series-list/">Time Series List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Organizations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../organizations_time-series-list/">Time Series List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_alert-policies-create/">Alert Policies Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_alert-policies-delete/">Alert Policies Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_alert-policies-get/">Alert Policies Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_alert-policies-list/">Alert Policies List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_alert-policies-patch/">Alert Policies Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_collectd-time-series-create/">Collectd Time Series Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-create/">Groups Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-delete/">Groups Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-get/">Groups Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-list/">Groups List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-members-list/">Groups Members List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_groups-update/">Groups Update</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Metric Descriptors Create</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_metric-descriptors-delete/">Metric Descriptors Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_metric-descriptors-get/">Metric Descriptors Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_metric-descriptors-list/">Metric Descriptors List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_monitored-resource-descriptors-get/">Monitored Resource Descriptors Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_monitored-resource-descriptors-list/">Monitored Resource Descriptors List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channel-descriptors-get/">Notification Channel Descriptors Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channel-descriptors-list/">Notification Channel Descriptors List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-create/">Notification Channels Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-delete/">Notification Channels Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-get/">Notification Channels Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-get-verification-code/">Notification Channels Get Verification Code</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-list/">Notification Channels List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-patch/">Notification Channels Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-send-verification-code/">Notification Channels Send Verification Code</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_notification-channels-verify/">Notification Channels Verify</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snoozes-create/">Snoozes Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snoozes-get/">Snoozes Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snoozes-list/">Snoozes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_snoozes-patch/">Snoozes Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_time-series-create/">Time Series Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_time-series-create-service/">Time Series Create Service</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_time-series-list/">Time Series List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_time-series-query/">Time Series Query</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_uptime-check-configs-create/">Uptime Check Configs Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_uptime-check-configs-delete/">Uptime Check Configs Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_uptime-check-configs-get/">Uptime Check Configs Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_uptime-check-configs-list/">Uptime Check Configs List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_uptime-check-configs-patch/">Uptime Check Configs Patch</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../services_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services_service-level-objectives-create/">Service Level Objectives Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services_service-level-objectives-delete/">Service Level Objectives Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services_service-level-objectives-get/">Service Level Objectives Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services_service-level-objectives-list/">Service Level Objectives List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services_service-level-objectives-patch/">Service Level Objectives Patch</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Uptime Check Ips</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../uptime-check-ips_list/">List</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Monitoring v5.0.4+20240225</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Projects &raquo;</li>
<li>Metric Descriptors Create</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/monitoring3-cli/edit/master/docs/projects_metric-descriptors-create.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Creates a new metric descriptor. The creation is executed asynchronously. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics). The metric descriptor is updated if it already exists, except that metric labels are never removed.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/monitoring</em></li>
<li><em>https://www.googleapis.com/auth/monitoring.write</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>monitoring3 --scope &lt;scope&gt; projects metric-descriptors-create ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: 4 projects/PROJECT_ID_OR_NUMBER</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>MetricDescriptor:
description: string
display-name: string
launch-stage: string
metadata:
ingest-delay: string
launch-stage: string
sample-period: string
metric-kind: string
monitored-resource-types: [string]
name: string
type: string
unit: string
value-type: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r . description=et</code><ul>
<li>A detailed description of the metric, which can be used in documentation.</li>
</ul>
</li>
<li><code>display-name=voluptua.</code><ul>
<li>A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example &#34;Request count&#34;. This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.</li>
</ul>
</li>
<li><code>launch-stage=amet.</code><ul>
<li>Optional. The launch stage of the metric definition.</li>
</ul>
</li>
<li><code>metadata ingest-delay=consetetur</code><ul>
<li>The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.</li>
</ul>
</li>
<li><code>launch-stage=diam</code><ul>
<li>Deprecated. Must use the MetricDescriptor.launch_stage instead.</li>
</ul>
</li>
<li>
<p><code>sample-period=dolor</code></p>
<ul>
<li>The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.</li>
</ul>
</li>
<li>
<p><code>.. metric-kind=et</code></p>
<ul>
<li>Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.</li>
</ul>
</li>
<li><code>monitored-resource-types=et</code><ul>
<li>Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>name=sadipscing</code><ul>
<li>The resource name of the metric descriptor.</li>
</ul>
</li>
<li><code>type=stet</code><ul>
<li>The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: &#34;custom.googleapis.com/invoice/paid/amount&#34; &#34;external.googleapis.com/prometheus/up&#34; &#34;appengine.googleapis.com/http/server/response_latencies&#34; </li>
</ul>
</li>
<li><code>unit=dolor</code><ul>
<li>The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { &#34;.&#34; Component } { &#34;/&#34; Component } ; Component = ( [ PREFIX ] UNIT | &#34;%&#34; ) [ Annotation ] | Annotation | &#34;1&#34; ; Annotation = &#34;{&#34; NAME &#34;}&#34; ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, &#34;new users per day&#34; can be represented as 1/d or {new-users}/d (and a metric value 5 would mean &#34;5 new users). Alternatively, &#34;thousands of page views per day&#34; would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean &#34;5300 page views per day&#34;). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means &#34;3 percent&#34;). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means &#34;3 percent&#34;).</li>
</ul>
</li>
<li><code>value-type=duo</code><ul>
<li>Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_groups-update/" class="btn btn-neutral float-left" title="Groups Update"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_metric-descriptors-delete/" class="btn btn-neutral float-right" title="Metric Descriptors Delete">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/monitoring3-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_groups-update/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_metric-descriptors-delete/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>