Skip to content

dp3.bin.shcmd.telemetry

Telemetry commands for the shell-oriented DP3 CLI.

handle_sources_validity 

handle_sources_validity(client, _args) -> int

Show source validity timestamps.

Source code in dp3/bin/shcmd/telemetry.py 
7
8
9
def handle_sources_validity(client, _args) -> int:
    """Show source validity timestamps."""
    return print_response_json(client.request("GET", "/telemetry/sources_validity"))

handle_source_age 

handle_source_age(client, args) -> int

Show source ages in the requested unit.

Source code in dp3/bin/shcmd/telemetry.py 
12
13
14
15
16
def handle_source_age(client, args) -> int:
    """Show source ages in the requested unit."""
    return print_response_json(
        client.request("GET", "/telemetry/sources_age", params={"unit": args.unit})
    )

handle_entities_per_attr 

handle_entities_per_attr(client, _args) -> int

Count entities with data present for each attribute.

Source code in dp3/bin/shcmd/telemetry.py 
19
20
21
def handle_entities_per_attr(client, _args) -> int:
    """Count entities with data present for each attribute."""
    return print_response_json(client.request("GET", "/telemetry/entities_per_attr"))

handle_snapshot_summary 

handle_snapshot_summary(client, _args) -> int

Show recent snapshot activity summary.

Source code in dp3/bin/shcmd/telemetry.py 
24
25
26
def handle_snapshot_summary(client, _args) -> int:
    """Show recent snapshot activity summary."""
    return print_response_json(client.request("GET", "/telemetry/snapshot_summary"))

handle_metadata 

handle_metadata(client, args) -> int

Browse internal metadata records.

Source code in dp3/bin/shcmd/telemetry.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def handle_metadata(client, args) -> int:
    """Browse internal metadata records."""
    params = {
        "skip": args.skip,
        "limit": args.limit,
        "sort": args.sort,
    }
    if args.module is not None:
        params["module"] = args.module
    if args.date_from is not None:
        params["date_from"] = args.date_from
    if args.date_to is not None:
        params["date_to"] = args.date_to

    if args.format == "ndjson":
        base_params = {k: v for k, v in params.items() if k not in {"skip", "limit"}}
        return stream_json_pages(client, "/telemetry/metadata", base_params, args.skip, args.limit)
    return print_response_json(client.request("GET", "/telemetry/metadata", params=params))

handle_rabbitmq_queues 

handle_rabbitmq_queues(client, _args) -> int

Show RabbitMQ queue telemetry.

Source code in dp3/bin/shcmd/telemetry.py 
49
50
51
def handle_rabbitmq_queues(client, _args) -> int:
    """Show RabbitMQ queue telemetry."""
    return print_response_json(client.request("GET", "/telemetry/rabbitmq/queues"))

register_parser 

register_parser(commands) -> None

Register telemetry commands on the root parser.

Source code in dp3/bin/shcmd/telemetry.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def register_parser(commands) -> None:
    """Register telemetry commands on the root parser."""
    telemetry_parser = commands.add_parser("telemetry", help="Read operational telemetry.")
    telemetry_commands = telemetry_parser.add_subparsers(dest="telemetry_command", required=True)

    sources_validity_parser = telemetry_commands.add_parser(
        "sources-validity", help="Show source validity timestamps."
    )
    sources_validity_parser.set_defaults(handler=handle_sources_validity)

    source_age_parser = telemetry_commands.add_parser("source-age", help="Show source ages.")
    source_age_parser.add_argument(
        "-u",
        "--unit",
        choices=["minutes", "seconds"],
        default="minutes",
    )
    source_age_parser.set_defaults(handler=handle_source_age)

    entities_per_attr_parser = telemetry_commands.add_parser(
        "entities-per-attr", help="Count entities with data present for each attribute."
    )
    entities_per_attr_parser.set_defaults(handler=handle_entities_per_attr)

    snapshot_summary_parser = telemetry_commands.add_parser(
        "snapshot-summary", help="Show recent snapshot activity summary."
    )
    snapshot_summary_parser.set_defaults(handler=handle_snapshot_summary)

    metadata_parser = telemetry_commands.add_parser(
        "metadata", help="Browse internal metadata records."
    )
    metadata_parser.add_argument("-m", "--module")
    metadata_parser.add_argument("-f", "--from", dest="date_from")
    metadata_parser.add_argument("-t", "--to", dest="date_to")
    metadata_parser.add_argument("-s", "--skip", type=int, default=0)
    metadata_parser.add_argument("-l", "--limit", type=int, default=0)
    metadata_parser.add_argument("-S", "--sort", choices=["newest", "oldest"], default="newest")
    metadata_parser.add_argument("-F", "--format", choices=["json", "ndjson"], default="ndjson")
    metadata_parser.set_defaults(handler=handle_metadata)

    rabbitmq_queues_parser = telemetry_commands.add_parser(
        "rabbitmq-queues", help="Show RabbitMQ queue telemetry."
    )
    rabbitmq_queues_parser.set_defaults(handler=handle_rabbitmq_queues)