File: //snap/google-cloud-cli/current/lib/surface/logging/metrics/create.py
# -*- coding: utf-8 -*- #
# Copyright 2015 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""'logging metrics create' command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.logging import util
from googlecloudsdk.calliope import arg_parsers
from googlecloudsdk.calliope import base
from googlecloudsdk.core import log
DETAILED_HELP = {
'DESCRIPTION':
"""\
Create a logs-based metric to count the number of log entries that
match a filter expression. Logs-based metrics can also be used to
extract values from logs and create a distribution of the values.
""",
'EXAMPLES':
"""\
To create a metric that counts the number of log entries with a
severity level higher than WARNING, run:
$ {command} high_severity_count --description="Number of high severity log entries" --log-filter="severity > WARNING"
Detailed information about filters can be found at:
[](https://cloud.google.com/logging/docs/view/logging-query-language)
To create a metric that uses advanced features like distribution or
user-defined labels, run:
$ {command} my_metric --config-from-file=$PATH_TO_FILE
The config file can be in YAML or JSON format. Detailed information
about how to configure metrics can be found at: [](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics#LogMetric).
To create a bucket log-based metric, run:
$ {command} my_bucket_metric --description="DESCRIPTION" --log-filter="LOG_FILTER" --bucket-name="BUCKET_NAME"
""",
}
@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA,
base.ReleaseTrack.ALPHA)
class Create(base.CreateCommand):
"""Create a logs-based metric."""
@staticmethod
def Args(parser):
"""Register flags for this command."""
parser.add_argument('metric_name', help='The name of the new metric.')
config_group = parser.add_argument_group(help='Data about the new metric.',
mutex=True,
required=True
)
legacy_mode_group = config_group.add_argument_group(
help=('A group of arguments to specify simple counter logs-based '
'metrics. '))
legacy_mode_group.add_argument(
'--description', required=True,
help='The metric\'s description.')
legacy_mode_group.add_argument(
'--log-filter', required=True,
help='The metric\'s filter expression.')
legacy_mode_group.add_argument(
'--bucket-name',
help='The Log Bucket name which owns the log-based metric.')
config_group.add_argument('--config-from-file',
help=('A path to a YAML or JSON file specifying '
'the logs-based metric to create.'),
type=arg_parsers.FileContents())
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
The created metric.
"""
messages = util.GetMessages()
new_metric = util.CreateLogMetric(
metric_name=args.metric_name,
description=args.description,
log_filter=args.log_filter,
bucket_name=args.bucket_name,
data=args.config_from_file)
request = messages.LoggingProjectsMetricsCreateRequest(
parent=util.GetCurrentProjectParent(), logMetric=new_metric)
result = util.GetClient().projects_metrics.Create(request)
log.CreatedResource(args.metric_name)
return result
Create.detailed_help = DETAILED_HELP