From 64c6bca4160ddc6b842c71be583b4328953ff4d9 Mon Sep 17 00:00:00 2001 From: Janae Quinones <62717289+Janaeq@users.noreply.github.com> Date: Thu, 12 Dec 2024 21:20:23 -0500 Subject: [PATCH] update teamcity docs for openmetrics (#19260) --- teamcity/README.md | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/teamcity/README.md b/teamcity/README.md index 0a4b3fba01c82..4bfa5eb867af7 100644 --- a/teamcity/README.md +++ b/teamcity/README.md @@ -59,23 +59,14 @@ The TeamCity check offers two methods of data collection. To optimally monitor y init_config: instances: - - server: http://teamcity..com - - ## @param projects - mapping - optional - ## Mapping of TeamCity projects and build configurations to - ## collect events and metrics from the TeamCity REST API. - # - projects: - : - include: - - - - - exclude: - - - : - include: - - - : {} + - use_openmetrics: true + + ## @param server - string - required + ## Specify the server name of your TeamCity instance. + ## Enable Guest Authentication on your instance or specify `username` and `password` to + ## enable basic HTTP authentication. + # + server: http://teamcity..com ``` To collect [OpenMetrics-compliant][16] histogram and summary metrics (available starting in TeamCity Server 2022.10+), add the internal property, `teamcity.metrics.followOpenMetricsSpec=true`. See, [TeamCity Internal Properties][25].