use SynapseCounter everywhere

Author: FrenchGithubUser

synapse/appservice/api.py

@@ -31,7 +31,6 @@
     Union,
 )
 
-from prometheus_client import Counter
 from typing_extensions import ParamSpec, TypeGuard
 
 from synapse.api.constants import EventTypes, Membership, ThirdPartyEntityKind
@@ -45,7 +44,7 @@
 from synapse.events.utils import SerializeEventConfig, serialize_event
 from synapse.http.client import SimpleHttpClient, is_unknown_endpoint
 from synapse.logging import opentracing
-from synapse.metrics import SERVER_NAME_LABEL
+from synapse.metrics import SERVER_NAME_LABEL, SynapseCounter
 from synapse.types import DeviceListUpdates, JsonDict, JsonMapping, ThirdPartyInstanceID
 from synapse.util.caches.response_cache import ResponseCache
 
@@ -54,31 +53,31 @@
 
 logger = logging.getLogger(__name__)
 
-sent_transactions_counter = Counter(
+sent_transactions_counter = SynapseCounter(
     "synapse_appservice_api_sent_transactions",
     "Number of /transactions/ requests sent",
     labelnames=["service", SERVER_NAME_LABEL],
 )
 
-failed_transactions_counter = Counter(
+failed_transactions_counter = SynapseCounter(
     "synapse_appservice_api_failed_transactions",
     "Number of /transactions/ requests that failed to send",
     labelnames=["service", SERVER_NAME_LABEL],
 )
 
-sent_events_counter = Counter(
+sent_events_counter = SynapseCounter(
     "synapse_appservice_api_sent_events",
     "Number of events sent to the AS",
     labelnames=["service", SERVER_NAME_LABEL],
 )
 
-sent_ephemeral_counter = Counter(
+sent_ephemeral_counter = SynapseCounter(
     "synapse_appservice_api_sent_ephemeral",
     "Number of ephemeral events sent to the AS",
     labelnames=["service", SERVER_NAME_LABEL],
 )
 
-sent_todevice_counter = Counter(
+sent_todevice_counter = SynapseCounter(
     "synapse_appservice_api_sent_todevice",
     "Number of todevice messages sent to the AS",
     labelnames=["service", SERVER_NAME_LABEL],

synapse/federation/federation_server.py

@@ -32,7 +32,7 @@
     Union,
 )
 
-from prometheus_client import Counter, Gauge, Histogram
+from prometheus_client import Gauge, Histogram
 
 from twisted.python import failure
 
@@ -79,7 +79,7 @@
     tag_args,
     trace,
 )
-from synapse.metrics import SERVER_NAME_LABEL
+from synapse.metrics import SERVER_NAME_LABEL, SynapseCounter
 from synapse.metrics.background_process_metrics import wrap_as_background_process
 from synapse.replication.http.federation import (
     ReplicationFederationSendEduRestServlet,
@@ -102,15 +102,15 @@
 
 logger = logging.getLogger(__name__)
 
-received_pdus_counter = Counter(
+received_pdus_counter = SynapseCounter(
     "synapse_federation_server_received_pdus", "", labelnames=[SERVER_NAME_LABEL]
 )
 
-received_edus_counter = Counter(
+received_edus_counter = SynapseCounter(
     "synapse_federation_server_received_edus", "", labelnames=[SERVER_NAME_LABEL]
 )
 
-received_queries_counter = Counter(
+received_queries_counter = SynapseCounter(
     "synapse_federation_server_received_queries",
     "",
     labelnames=["type", SERVER_NAME_LABEL],

synapse/federation/sender/__init__.py

@@ -142,7 +142,6 @@
 )
 
 import attr
-from prometheus_client import Counter
 
 from twisted.internet import defer
 
@@ -160,6 +159,7 @@
 from synapse.metrics import (
     SERVER_NAME_LABEL,
     LaterGauge,
+    SynapseCounter,
     event_processing_loop_counter,
     event_processing_loop_room_count,
     events_processed_counter,
@@ -184,13 +184,13 @@
 
 logger = logging.getLogger(__name__)
 
-sent_pdus_destination_dist_count = Counter(
+sent_pdus_destination_dist_count = SynapseCounter(
     "synapse_federation_client_sent_pdu_destinations_count",
     "Number of PDUs queued for sending to one or more destinations",
     labelnames=[SERVER_NAME_LABEL],
 )
 
-sent_pdus_destination_dist_total = Counter(
+sent_pdus_destination_dist_total = SynapseCounter(
     "synapse_federation_client_sent_pdu_destinations",
     "Total number of PDUs queued for sending across all destinations",
     labelnames=[SERVER_NAME_LABEL],

synapse/federation/sender/per_destination_queue.py

@@ -26,7 +26,6 @@
 from typing import TYPE_CHECKING, Hashable, Iterable, Optional
 
 import attr
-from prometheus_client import Counter
 
 from twisted.internet import defer
 
@@ -42,7 +41,7 @@
 from synapse.handlers.presence import format_user_presence_state
 from synapse.logging import issue9533_logger
 from synapse.logging.opentracing import SynapseTags, set_tag
-from synapse.metrics import SERVER_NAME_LABEL, sent_transactions_counter
+from synapse.metrics import SERVER_NAME_LABEL, SynapseCounter, sent_transactions_counter
 from synapse.types import JsonDict, ReadReceipt
 from synapse.util.retryutils import NotRetryingDestination, get_retry_limiter
 from synapse.visibility import filter_events_for_server
@@ -56,13 +55,13 @@
 logger = logging.getLogger(__name__)
 
 
-sent_edus_counter = Counter(
+sent_edus_counter = SynapseCounter(
     "synapse_federation_client_sent_edus",
     "Total number of EDUs successfully sent",
     labelnames=[SERVER_NAME_LABEL],
 )
 
-sent_edus_by_type = Counter(
+sent_edus_by_type = SynapseCounter(
     "synapse_federation_client_sent_edus_by_type",
     "Number of sent EDUs successfully sent, by event type",
     labelnames=["type", SERVER_NAME_LABEL],

synapse/handlers/appservice.py

@@ -28,8 +28,6 @@
     Union,
 )
 
-from prometheus_client import Counter
-
 from twisted.internet import defer
 
 import synapse
@@ -40,6 +38,7 @@
 from synapse.logging.context import make_deferred_yieldable, run_in_background
 from synapse.metrics import (
     SERVER_NAME_LABEL,
+    SynapseCounter,
     event_processing_loop_counter,
     event_processing_loop_room_count,
 )
@@ -65,7 +64,7 @@
 
 logger = logging.getLogger(__name__)
 
-events_processed_counter = Counter(
+events_processed_counter = SynapseCounter(
     "synapse_handlers_appservice_events_processed", "", labelnames=[SERVER_NAME_LABEL]
 )
 

synapse/handlers/auth.py

@@ -41,7 +41,6 @@
 import attr
 import bcrypt
 import unpaddedbase64
-from prometheus_client import Counter
 
 from twisted.internet.defer import CancelledError
 from twisted.web.server import Request
@@ -66,7 +65,7 @@
 from synapse.http.server import finish_request, respond_with_html
 from synapse.http.site import SynapseRequest
 from synapse.logging.context import defer_to_thread
-from synapse.metrics import SERVER_NAME_LABEL
+from synapse.metrics import SERVER_NAME_LABEL, SynapseCounter
 from synapse.metrics.background_process_metrics import run_as_background_process
 from synapse.storage.databases.main.registration import (
     LoginTokenExpired,
@@ -89,7 +88,7 @@
 
 INVALID_USERNAME_OR_PASSWORD = "Invalid username or password"
 
-invalid_login_token_counter = Counter(
+invalid_login_token_counter = SynapseCounter(
     "synapse_user_login_invalid_login_tokens",
     "Counts the number of rejected m.login.token on /login",
     labelnames=["reason", SERVER_NAME_LABEL],

synapse/handlers/federation_event.py

@@ -32,7 +32,7 @@
     Sequence,
 )
 
-from prometheus_client import Counter, Histogram
+from prometheus_client import Histogram
 
 from synapse import event_auth
 from synapse.api.constants import (
@@ -76,7 +76,7 @@
     tag_args,
     trace,
 )
-from synapse.metrics import SERVER_NAME_LABEL
+from synapse.metrics import SERVER_NAME_LABEL, SynapseCounter
 from synapse.replication.http.federation import (
     ReplicationFederationSendEventsRestServlet,
 )
@@ -102,7 +102,7 @@
 
 logger = logging.getLogger(__name__)
 
-soft_failed_event_counter = Counter(
+soft_failed_event_counter = SynapseCounter(
     "synapse_federation_soft_failed_events_total",
     "Events received over federation that we marked as soft_failed",
     labelnames=[SERVER_NAME_LABEL],

synapse/handlers/presence.py

@@ -91,16 +91,14 @@
     Optional,
 )
 
-from prometheus_client import Counter
-
 import synapse.metrics
 from synapse.api.constants import EduTypes, EventTypes, Membership, PresenceState
 from synapse.api.errors import SynapseError
 from synapse.api.presence import UserDevicePresenceState, UserPresenceState
 from synapse.appservice import ApplicationService
 from synapse.events.presence_router import PresenceRouter
 from synapse.logging.context import run_in_background
-from synapse.metrics import SERVER_NAME_LABEL, LaterGauge
+from synapse.metrics import SERVER_NAME_LABEL, LaterGauge, SynapseCounter
 from synapse.metrics.background_process_metrics import (
     wrap_as_background_process,
 )
@@ -131,37 +129,37 @@
 logger = logging.getLogger(__name__)
 
 
-notified_presence_counter = Counter(
+notified_presence_counter = SynapseCounter(
     "synapse_handler_presence_notified_presence", "", labelnames=[SERVER_NAME_LABEL]
 )
-federation_presence_out_counter = Counter(
+federation_presence_out_counter = SynapseCounter(
     "synapse_handler_presence_federation_presence_out",
     "",
     labelnames=[SERVER_NAME_LABEL],
 )
-presence_updates_counter = Counter(
+presence_updates_counter = SynapseCounter(
     "synapse_handler_presence_presence_updates", "", labelnames=[SERVER_NAME_LABEL]
 )
-timers_fired_counter = Counter(
+timers_fired_counter = SynapseCounter(
     "synapse_handler_presence_timers_fired", "", labelnames=[SERVER_NAME_LABEL]
 )
-federation_presence_counter = Counter(
+federation_presence_counter = SynapseCounter(
     "synapse_handler_presence_federation_presence", "", labelnames=[SERVER_NAME_LABEL]
 )
-bump_active_time_counter = Counter(
+bump_active_time_counter = SynapseCounter(
     "synapse_handler_presence_bump_active_time", "", labelnames=[SERVER_NAME_LABEL]
 )
 
-get_updates_counter = Counter(
+get_updates_counter = SynapseCounter(
     "synapse_handler_presence_get_updates", "", labelnames=["type", SERVER_NAME_LABEL]
 )
 
-notify_reason_counter = Counter(
+notify_reason_counter = SynapseCounter(
     "synapse_handler_presence_notify_reason",
     "",
     labelnames=["locality", "reason", SERVER_NAME_LABEL],
 )
-state_transition_counter = Counter(
+state_transition_counter = SynapseCounter(
     "synapse_handler_presence_state_transition",
     "",
     labelnames=["locality", "from", "to", SERVER_NAME_LABEL],

synapse/handlers/register.py

@@ -30,8 +30,6 @@
     TypedDict,
 )
 
-from prometheus_client import Counter
-
 from synapse import types
 from synapse.api.constants import (
     MAX_USERID_LENGTH,
@@ -50,7 +48,7 @@
 from synapse.appservice import ApplicationService
 from synapse.config.server import is_threepid_reserved
 from synapse.http.servlet import assert_params_in_dict
-from synapse.metrics import SERVER_NAME_LABEL
+from synapse.metrics import SERVER_NAME_LABEL, SynapseCounter
 from synapse.replication.http.login import RegisterDeviceReplicationServlet
 from synapse.replication.http.register import (
     ReplicationPostRegisterActionsServlet,
@@ -65,13 +63,13 @@
 logger = logging.getLogger(__name__)
 
 
-registration_counter = Counter(
+registration_counter = SynapseCounter(
     "synapse_user_registrations_total",
     "Number of new users registered (since restart)",
     labelnames=["guest", "shadow_banned", "auth_provider", SERVER_NAME_LABEL],
 )
 
-login_counter = Counter(
+login_counter = SynapseCounter(
     "synapse_user_logins_total",
     "Number of user logins (since restart)",
     labelnames=["guest", "auth_provider", SERVER_NAME_LABEL],

synapse/handlers/sync.py

@@ -30,7 +30,6 @@
 )
 
 import attr
-from prometheus_client import Counter
 
 from synapse.api.constants import (
     AccountDataTypes,
@@ -54,7 +53,7 @@
     start_active_span,
     trace,
 )
-from synapse.metrics import SERVER_NAME_LABEL
+from synapse.metrics import SERVER_NAME_LABEL, SynapseCounter
 from synapse.storage.databases.main.event_push_actions import RoomNotifCounts
 from synapse.storage.databases.main.roommember import extract_heroes_from_room_summary
 from synapse.storage.databases.main.stream import PaginateFunction
@@ -91,7 +90,7 @@
 # "initial_sync", "full_state_sync" or "incremental_sync", `lazy_loaded` is
 # "true" or "false" depending on if the request asked for lazy loaded members or
 # not.
-non_empty_sync_counter = Counter(
+non_empty_sync_counter = SynapseCounter(
     "synapse_handlers_sync_nonempty_total",
     "Count of non empty sync responses. type is initial_sync/full_state_sync"
     "/incremental_sync. lazy_loaded indicates if lazy loaded members were "