Coverage for python / lsst / daf / butler / remote_butler / server / _telemetry.py: 0%

1# This file is part of daf_butler. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <http://www.gnu.org/licenses/>. 

27 

28import os 

29from collections.abc import Iterator 

30from contextlib import AbstractContextManager, contextmanager 

31from typing import Any, Protocol 

32 

33try: 

34 import sentry_sdk 

35 

36 _SENTRY_AVAILABLE = True 

37except ImportError: 

38 _SENTRY_AVAILABLE = False 

39 

40 

41class TelemetryContext(Protocol): 

42 """Interface for adding information to trace telemetry.""" 

43 

44 def span(self, name: str) -> AbstractContextManager[None]: ... 

45 

46 

47class NullTelemetryContext(TelemetryContext): 

48 """No-op implementation of telemetry used when no telemetry provider is 

49 configured. 

50 """ 

51 

52 @contextmanager 

53 def span(self, name: str) -> Iterator[None]: 

54 yield 

55 

56 

57class SentryTelemetryContext(TelemetryContext): 

58 """Implementation of telemetry using Sentry.""" 

59 

60 @contextmanager 

61 def span(self, name: str) -> Iterator[None]: 

62 with sentry_sdk.start_span(name=name): 

63 yield 

64 

65 

66_telemetry_context: TelemetryContext = NullTelemetryContext() 

67 

68 

69def enable_telemetry() -> None: 

70 """Turn on upload of trace telemetry to Sentry, to allow performance 

71 debugging of deployed server. 

72 """ 

73 if not _SENTRY_AVAILABLE: 

74 return 

75 

76 # Configuration will be pulled from SENTRY_* environment variables 

77 # (see https://docs.sentry.io/platforms/python/configuration/options/). 

78 # If SENTRY_DSN is not present, telemetry is disabled. 

79 sentry_sdk.init(traces_sampler=_decide_whether_to_sample_trace) 

80 

81 global _telemetry_context 

82 _telemetry_context = SentryTelemetryContext() 

83 

84 

85def get_telemetry_context() -> TelemetryContext: 

86 """Return an object that can be used to add information to the trace 

87 telemetry. 

88 

89 Returns 

90 ------- 

91 telemetry_context : `TelemetryContext` 

92 Object that can be used to add information to the trace telemetry. 

93 """ 

94 return _telemetry_context 

95 

96 

97def _decide_whether_to_sample_trace(context: dict[str, Any]) -> float: 

98 asgi_scope = context.get("asgi_scope") 

99 if asgi_scope is not None: 

100 # Do not log health check endpoint. 

101 if asgi_scope.get("path") == "/": 

102 return 0 

103 

104 sampling_rate = float(os.getenv("BUTLER_TRACE_SAMPLING_RATE", "0.02")) 

105 return sampling_rate