checktrace 0.0.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checktrace/__init__.py
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"""
|
|
2
|
+
checktrace - Python SDK for distributed tracing via TraceHub.
|
|
3
|
+
|
|
4
|
+
NOTE: This is a placeholder package. The full implementation is available at:
|
|
5
|
+
|
|
6
|
+
pip install checktrace --extra-index-url https://pip.muid.io/simple/
|
|
7
|
+
|
|
8
|
+
For documentation, see: https://github.com/muid-io/checktrace
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
__version__ = "0.0.1"
|
|
12
|
+
|
|
13
|
+
_INSTALL_MESSAGE = """
|
|
14
|
+
================================================================================
|
|
15
|
+
checktrace: This is a placeholder package on PyPI.
|
|
16
|
+
|
|
17
|
+
The full checktrace SDK is available from pip.muid.io:
|
|
18
|
+
|
|
19
|
+
pip install checktrace --extra-index-url https://pip.muid.io/simple/
|
|
20
|
+
|
|
21
|
+
Or with FastAPI middleware support:
|
|
22
|
+
|
|
23
|
+
pip install "checktrace[middleware]" --extra-index-url https://pip.muid.io/simple/
|
|
24
|
+
|
|
25
|
+
Documentation: https://github.com/muid-io/checktrace
|
|
26
|
+
================================================================================
|
|
27
|
+
"""
|
|
28
|
+
|
|
29
|
+
def _show_install_message():
|
|
30
|
+
print(_INSTALL_MESSAGE)
|
|
31
|
+
|
|
32
|
+
# Show message on import
|
|
33
|
+
_show_install_message()
|
|
34
|
+
|
|
35
|
+
# Raise error if someone tries to use it
|
|
36
|
+
class CheckTraceConfig:
|
|
37
|
+
def __init__(self, *args, **kwargs):
|
|
38
|
+
raise NotImplementedError(_INSTALL_MESSAGE)
|
|
39
|
+
|
|
40
|
+
def init_tracing(*args, **kwargs):
|
|
41
|
+
raise NotImplementedError(_INSTALL_MESSAGE)
|
|
42
|
+
|
|
43
|
+
def checkpoint(*args, **kwargs):
|
|
44
|
+
raise NotImplementedError(_INSTALL_MESSAGE)
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: checktrace
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Placeholder for checktrace SDK. Install from pip.muid.io for full version.
|
|
5
|
+
Project-URL: Homepage, https://muid.io
|
|
6
|
+
Project-URL: Repository, https://github.com/muid-io/checktrace
|
|
7
|
+
Project-URL: Documentation, https://pip.muid.io
|
|
8
|
+
Author-email: "MUID.io" <dev@muid.io>
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
Keywords: distributed,observability,placeholder,tracing
|
|
11
|
+
Classifier: Development Status :: 1 - Planning
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Requires-Python: >=3.8
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
|
|
18
|
+
# checktrace
|
|
19
|
+
|
|
20
|
+
**This is a placeholder package on PyPI.**
|
|
21
|
+
|
|
22
|
+
The full checktrace SDK (Python SDK for distributed tracing via TraceHub) is available from our private package index.
|
|
23
|
+
|
|
24
|
+
## Installation
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
pip install checktrace --extra-index-url https://pip.muid.io/simple/
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
With FastAPI middleware support:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
pip install "checktrace[middleware]" --extra-index-url https://pip.muid.io/simple/
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Features (in full version)
|
|
37
|
+
|
|
38
|
+
- Config-driven tracing initialization
|
|
39
|
+
- ContextVar-based correlation ID propagation (async-safe)
|
|
40
|
+
- Auto-redaction of sensitive data
|
|
41
|
+
- Non-blocking trace sending (background thread)
|
|
42
|
+
- FastAPI middleware for automatic request tracing
|
|
43
|
+
- `@checkpoint` decorator for function tracing
|
|
44
|
+
- CLI for querying traces (`checktrace list/get/stream`)
|
|
45
|
+
|
|
46
|
+
## Quick Start (after installing from pip.muid.io)
|
|
47
|
+
|
|
48
|
+
```python
|
|
49
|
+
from checktrace import CheckTraceConfig, init_tracing, checkpoint
|
|
50
|
+
|
|
51
|
+
config = CheckTraceConfig(
|
|
52
|
+
tracehub_url="http://tracehub:8099",
|
|
53
|
+
project_name="myapp",
|
|
54
|
+
default_source_id="MA",
|
|
55
|
+
)
|
|
56
|
+
init_tracing(config)
|
|
57
|
+
|
|
58
|
+
@checkpoint("MA", "process_request")
|
|
59
|
+
async def process_request(data: dict):
|
|
60
|
+
return {"status": "ok"}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Links
|
|
64
|
+
|
|
65
|
+
- **Full package:** https://pip.muid.io/simple/checktrace/
|
|
66
|
+
- **Documentation:** https://github.com/muid-io/checktrace
|
|
67
|
+
- **MUID.io:** https://muid.io
|
|
68
|
+
|
|
69
|
+
## License
|
|
70
|
+
|
|
71
|
+
MIT
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
checktrace/__init__.py,sha256=UQSW5mNAnRbgjT3u9RuYKdg3mY6sHE7KQIbHmZbx2Xg,1292
|
|
2
|
+
checktrace-0.0.1.dist-info/METADATA,sha256=UQHL3Txl1taCnnFoznjU_yYFMkBhI13i7_7llFsg4Yk,1996
|
|
3
|
+
checktrace-0.0.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
|
|
4
|
+
checktrace-0.0.1.dist-info/RECORD,,
|