mirror of
https://chromium.googlesource.com/chromium/tools/depot_tools.git
synced 2026-01-11 02:31:29 +00:00
75449d2000
These tools are still being evaluated and may change. get_build vs get_build_from_id and get_build_from_build_number in particular are two distinct ways of implementing the same tool that need to be compared. get_build gives flexibility but is extremely verbose which means it might be too flaky or consume unnecessary tokens. The return of these might also need filtering for unnecessary output. Particularly steps which can be very verbose without much information. Bug: 430952168 Change-Id: Ia9b092a6b6c546198939deb36ea1b89ff33d7fc6 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/6758660 Auto-Submit: Struan Shrimpton <sshrimp@google.com> Reviewed-by: Gavin Mak <gavinmak@google.com> Reviewed-by: Erik Staab <estaab@chromium.org> Commit-Queue: Struan Shrimpton <sshrimp@google.com>
135 lines
4.5 KiB
Python
135 lines
4.5 KiB
Python
# Copyright 2024 The Chromium Authors
|
|
# Use of this source code is governed by a BSD-style license that can be
|
|
# found in the LICENSE file.
|
|
from typing import Optional
|
|
import socket
|
|
import sys
|
|
|
|
from opentelemetry import trace as otel_trace_api
|
|
from opentelemetry.sdk import (
|
|
resources as otel_resources,
|
|
trace as otel_trace_sdk,
|
|
)
|
|
from opentelemetry.sdk.trace import export as otel_export
|
|
|
|
from . import config
|
|
from . import clearcut_span_exporter
|
|
from . import detector
|
|
|
|
DEFAULT_BANNER = """
|
|
===============================================================================
|
|
To help improve the quality of this product, we collect usage data and
|
|
stacktraces from googlers. This includes a uuid generated weekly to identify
|
|
invocation from the same users as well as metrics as described in
|
|
go/chrome-infra-telemetry-readme. You may choose to opt out of this collection
|
|
at any time by setting the flag `enabled = False` under [trace] section in
|
|
{config_file}
|
|
or by executing from your depot_tools checkout:
|
|
|
|
vpython3 third_party/depot_tools/infra_lib/telemetry --disable
|
|
|
|
This notice will be displayed {run_count} more times.
|
|
===============================================================================
|
|
"""
|
|
|
|
# This does not include Googlers' physical machines/laptops
|
|
_GOOGLE_HOSTNAME_SUFFIX = ('.google.com', '.googler.com', '.googlers.com')
|
|
|
|
# The version keeps track of telemetry changes.
|
|
_TELEMETRY_VERSION = '3'
|
|
|
|
|
|
def get_host_name(fully_qualified: bool = False) -> str:
|
|
"""Return hostname of current machine, with domain if |fully_qualified|."""
|
|
hostname = socket.gethostname()
|
|
try:
|
|
hostname = socket.gethostbyaddr(hostname)[0]
|
|
except (socket.gaierror, socket.herror) as e:
|
|
if sys.platform.startswith('linux'):
|
|
print(
|
|
'please check your /etc/hosts file; resolving your hostname'
|
|
f' ({hostname}) failed: {e}',
|
|
file=sys.stderr)
|
|
|
|
if fully_qualified:
|
|
return hostname
|
|
return hostname.partition('.')[0]
|
|
|
|
|
|
def is_google_host() -> bool:
|
|
"""Checks if the code is running on google host."""
|
|
|
|
hostname = get_host_name(fully_qualified=True)
|
|
return hostname.endswith(_GOOGLE_HOSTNAME_SUFFIX)
|
|
|
|
|
|
def initialize(service_name,
|
|
notice=DEFAULT_BANNER,
|
|
cfg_file=config.DEFAULT_CONFIG_FILE):
|
|
|
|
cfg = config.Config(cfg_file)
|
|
if cfg.trace_config.disabled():
|
|
return
|
|
|
|
bot_enabled = (cfg.trace_config.has_enabled()
|
|
and cfg.trace_config.enabled_reason == 'BOT_USER')
|
|
if not is_google_host() and not bot_enabled:
|
|
return
|
|
|
|
if not cfg.trace_config.has_enabled():
|
|
if cfg.root_config.notice_countdown > -1:
|
|
print(notice.format(run_count=cfg.root_config.notice_countdown,
|
|
config_file=cfg_file),
|
|
file=sys.stderr)
|
|
cfg.root_config.update(
|
|
notice_countdown=cfg.root_config.notice_countdown - 1)
|
|
else:
|
|
cfg.trace_config.update(enabled=True, reason='AUTO')
|
|
|
|
cfg.flush()
|
|
|
|
default_resource = otel_resources.Resource.create({
|
|
otel_resources.SERVICE_NAME:
|
|
service_name,
|
|
'telemetry.version':
|
|
_TELEMETRY_VERSION,
|
|
})
|
|
|
|
detected_resource = otel_resources.get_aggregated_resources([
|
|
otel_resources.ProcessResourceDetector(),
|
|
otel_resources.OTELResourceDetector(),
|
|
detector.ProcessDetector(),
|
|
detector.SystemDetector(),
|
|
])
|
|
|
|
resource = detected_resource.merge(default_resource)
|
|
trace_provider = otel_trace_sdk.TracerProvider(resource=resource)
|
|
otel_trace_api.set_tracer_provider(trace_provider)
|
|
trace_provider.add_span_processor(
|
|
otel_export.BatchSpanProcessor(
|
|
# Replace with ConsoleSpanExporter() to debug spans on the console
|
|
clearcut_span_exporter.ClearcutSpanExporter()))
|
|
|
|
|
|
def get_tracer(name: str, version: Optional[str] = None):
|
|
return otel_trace_api.get_tracer(name, version)
|
|
|
|
|
|
def opted_in(cfg_file=config.DEFAULT_CONFIG_FILE):
|
|
"""Get if the user is opted-in
|
|
|
|
Unlike initialize which continues when not explicitly opted out this will
|
|
return if the user is opted in, either by user or automatically after the
|
|
banner display period.
|
|
"""
|
|
cfg = config.Config(cfg_file)
|
|
if cfg.trace_config.disabled():
|
|
return False
|
|
|
|
bot_enabled = (cfg.trace_config.has_enabled()
|
|
and cfg.trace_config.enabled_reason == 'BOT_USER')
|
|
if not is_google_host() and not bot_enabled:
|
|
return False
|
|
|
|
cfg = config.Config(cfg_file)
|
|
return cfg.trace_config.enabled |