@smplkit/sdk 3.0.30 → 3.0.32
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.
- package/dist/index.d.cts +204 -43
- package/dist/index.d.ts +204 -43
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -439,6 +439,11 @@ interface components$1 {
|
|
|
439
439
|
};
|
|
440
440
|
/**
|
|
441
441
|
* LogGroup
|
|
442
|
+
* @description A named collection of loggers that share a level configuration.
|
|
443
|
+
*
|
|
444
|
+
* Assigning a logger to a group ties the logger's effective level to
|
|
445
|
+
* the group's level (and per-environment overrides). Loggers can move
|
|
446
|
+
* between groups or be detached from a group entirely.
|
|
442
447
|
* @example {
|
|
443
448
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
444
449
|
* "environments": {
|
|
@@ -452,28 +457,61 @@ interface components$1 {
|
|
|
452
457
|
* }
|
|
453
458
|
*/
|
|
454
459
|
LogGroup: {
|
|
455
|
-
/**
|
|
460
|
+
/**
|
|
461
|
+
* Name
|
|
462
|
+
* @description Human-readable label for the group.
|
|
463
|
+
*/
|
|
456
464
|
name: string;
|
|
457
|
-
/**
|
|
458
|
-
|
|
459
|
-
|
|
465
|
+
/**
|
|
466
|
+
* Level
|
|
467
|
+
* @description Default level applied to every logger in the group. `null` leaves member loggers to inherit from elsewhere.
|
|
468
|
+
*/
|
|
469
|
+
level?: ("TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL" | "SILENT") | null;
|
|
470
|
+
/**
|
|
471
|
+
* Parent Id
|
|
472
|
+
* @description Reserved for nested groups. Must be `null` in this version; nested groups are not yet supported.
|
|
473
|
+
*/
|
|
460
474
|
parent_id?: string | null;
|
|
461
|
-
/**
|
|
475
|
+
/**
|
|
476
|
+
* Environments
|
|
477
|
+
* @description Per-environment level overrides keyed by environment name. Each value is an object with an optional `level` field, e.g. `{"production": {"level": "ERROR"}}`. Member loggers inherit the per-environment level unless they set their own override.
|
|
478
|
+
*/
|
|
462
479
|
environments?: {
|
|
463
480
|
[key: string]: unknown;
|
|
464
481
|
} | null;
|
|
465
|
-
/**
|
|
482
|
+
/**
|
|
483
|
+
* Created At
|
|
484
|
+
* @description When the group was created.
|
|
485
|
+
*/
|
|
466
486
|
readonly created_at?: string | null;
|
|
467
|
-
/**
|
|
487
|
+
/**
|
|
488
|
+
* Updated At
|
|
489
|
+
* @description When the group was last modified.
|
|
490
|
+
*/
|
|
468
491
|
readonly updated_at?: string | null;
|
|
469
492
|
};
|
|
470
|
-
/**
|
|
493
|
+
/**
|
|
494
|
+
* LogGroupListResponse
|
|
495
|
+
* @description JSON:API collection response for log groups.
|
|
496
|
+
*/
|
|
471
497
|
LogGroupListResponse: {
|
|
472
498
|
/** Data */
|
|
473
499
|
data: components$1["schemas"]["LogGroupResource"][];
|
|
474
500
|
};
|
|
501
|
+
/**
|
|
502
|
+
* LogGroupRequest
|
|
503
|
+
* @description JSON:API request envelope for creating or updating a log group.
|
|
504
|
+
*/
|
|
505
|
+
LogGroupRequest: {
|
|
506
|
+
data: components$1["schemas"]["LogGroupResource"];
|
|
507
|
+
};
|
|
475
508
|
/**
|
|
476
509
|
* LogGroupResource
|
|
510
|
+
* @description JSON:API resource envelope for a log group.
|
|
511
|
+
*
|
|
512
|
+
* `id` is the group's key (e.g. `database-loggers`). On a create
|
|
513
|
+
* request the id may be supplied; if omitted, the server generates
|
|
514
|
+
* one from `name`.
|
|
477
515
|
* @example {
|
|
478
516
|
* "attributes": {
|
|
479
517
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
@@ -500,12 +538,22 @@ interface components$1 {
|
|
|
500
538
|
type: "log_group";
|
|
501
539
|
attributes: components$1["schemas"]["LogGroup"];
|
|
502
540
|
};
|
|
503
|
-
/**
|
|
541
|
+
/**
|
|
542
|
+
* LogGroupResponse
|
|
543
|
+
* @description JSON:API single-resource response envelope for a log group.
|
|
544
|
+
*/
|
|
504
545
|
LogGroupResponse: {
|
|
505
546
|
data: components$1["schemas"]["LogGroupResource"];
|
|
506
547
|
};
|
|
507
548
|
/**
|
|
508
549
|
* Logger
|
|
550
|
+
* @description A logger configured for the account.
|
|
551
|
+
*
|
|
552
|
+
* Loggers are organized by dot-separated key (for example, `sqlalchemy.engine`),
|
|
553
|
+
* matching the hierarchical naming convention used by most logging
|
|
554
|
+
* frameworks. A managed logger applies the configured level to every
|
|
555
|
+
* runtime where the logger appears; unmanaged loggers are tracked only
|
|
556
|
+
* as observations from SDKs.
|
|
509
557
|
* @example {
|
|
510
558
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
511
559
|
* "environments": {
|
|
@@ -524,33 +572,61 @@ interface components$1 {
|
|
|
524
572
|
* }
|
|
525
573
|
*/
|
|
526
574
|
Logger: {
|
|
527
|
-
/**
|
|
575
|
+
/**
|
|
576
|
+
* Name
|
|
577
|
+
* @description Human-readable label for the logger.
|
|
578
|
+
*/
|
|
528
579
|
name: string;
|
|
529
|
-
/**
|
|
530
|
-
|
|
531
|
-
|
|
580
|
+
/**
|
|
581
|
+
* Level
|
|
582
|
+
* @description Account-wide log level applied to this logger. `null` means no override at the logger level — the level is inherited from the logger's group or the framework default.
|
|
583
|
+
*/
|
|
584
|
+
level?: ("TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL" | "SILENT") | null;
|
|
585
|
+
/**
|
|
586
|
+
* Group
|
|
587
|
+
* @description Key of the log group this logger belongs to, or `null` if the logger is not grouped. Assigning a logger to a group promotes it to managed; assigning a group cascades to unmanaged descendants by clearing their group reference.
|
|
588
|
+
*/
|
|
532
589
|
group?: string | null;
|
|
533
|
-
/**
|
|
590
|
+
/**
|
|
591
|
+
* Managed
|
|
592
|
+
* @description When `true`, the logger is part of the account's managed configuration and counts toward the managed-loggers usage counter. Setting `level`, `group`, or `environments` on an unmanaged logger promotes it to managed automatically.
|
|
593
|
+
*/
|
|
534
594
|
managed?: boolean | null;
|
|
535
|
-
/**
|
|
595
|
+
/**
|
|
596
|
+
* Sources
|
|
597
|
+
* @description Service / environment observations reported by SDKs for this logger. Each entry carries the service name, environment, the level the SDK saw, the resolved level after framework inheritance, and timestamps for the first and most recent sighting.
|
|
598
|
+
*/
|
|
536
599
|
readonly sources?: {
|
|
537
600
|
[key: string]: unknown;
|
|
538
601
|
}[] | null;
|
|
539
|
-
/**
|
|
602
|
+
/**
|
|
603
|
+
* Environments
|
|
604
|
+
* @description Per-environment level overrides keyed by environment name. Each value is an object with an optional `level` field, e.g. `{"production": {"level": "WARN"}}`. An environment may be present with no `level` to record that the logger applies there without changing the resolved level.
|
|
605
|
+
*/
|
|
540
606
|
environments?: {
|
|
541
607
|
[key: string]: unknown;
|
|
542
608
|
} | null;
|
|
543
|
-
/**
|
|
609
|
+
/**
|
|
610
|
+
* Effective Levels
|
|
611
|
+
* @description Per-environment summary of what runtimes are reporting for this logger. Keyed by environment name; each entry is one of `{"status": "none"}`, `{"status": "agrees", "level": "<LEVEL>"}`, or `{"status": "varies"}`. `agrees` means every observed source in that environment reports the same resolved level; `varies` means at least two sources disagree.
|
|
612
|
+
*/
|
|
544
613
|
readonly effective_levels?: {
|
|
545
614
|
[key: string]: unknown;
|
|
546
615
|
} | null;
|
|
547
|
-
/**
|
|
616
|
+
/**
|
|
617
|
+
* Created At
|
|
618
|
+
* @description When the logger was first created or discovered.
|
|
619
|
+
*/
|
|
548
620
|
readonly created_at?: string | null;
|
|
549
|
-
/**
|
|
621
|
+
/**
|
|
622
|
+
* Updated At
|
|
623
|
+
* @description When the logger was last modified.
|
|
624
|
+
*/
|
|
550
625
|
readonly updated_at?: string | null;
|
|
551
626
|
};
|
|
552
627
|
/**
|
|
553
628
|
* LoggerBulkItem
|
|
629
|
+
* @description One logger discovered by an SDK during a bulk registration call.
|
|
554
630
|
* @example {
|
|
555
631
|
* "environment": "production",
|
|
556
632
|
* "id": "sqlalchemy.engine",
|
|
@@ -562,32 +638,33 @@ interface components$1 {
|
|
|
562
638
|
LoggerBulkItem: {
|
|
563
639
|
/**
|
|
564
640
|
* Id
|
|
565
|
-
* @description
|
|
641
|
+
* @description Dot-separated logger key as the SDK saw it.
|
|
566
642
|
*/
|
|
567
643
|
id: string;
|
|
568
644
|
/**
|
|
569
645
|
* Level
|
|
570
|
-
* @description
|
|
646
|
+
* @description Level explicitly set on the logger by application code. `null` when the level is inherited.
|
|
571
647
|
*/
|
|
572
648
|
level?: string | null;
|
|
573
649
|
/**
|
|
574
650
|
* Resolved Level
|
|
575
|
-
* @description
|
|
651
|
+
* @description Effective level after framework inheritance. SDKs should always report this; the server falls back to `level` when `resolved_level` is missing.
|
|
576
652
|
*/
|
|
577
653
|
resolved_level?: string | null;
|
|
578
654
|
/**
|
|
579
655
|
* Service
|
|
580
|
-
* @description Service name that
|
|
656
|
+
* @description Service name that observed the logger.
|
|
581
657
|
*/
|
|
582
658
|
service?: string | null;
|
|
583
659
|
/**
|
|
584
660
|
* Environment
|
|
585
|
-
* @description Environment where
|
|
661
|
+
* @description Environment where the logger was observed.
|
|
586
662
|
*/
|
|
587
663
|
environment?: string | null;
|
|
588
664
|
};
|
|
589
665
|
/**
|
|
590
666
|
* LoggerBulkRequest
|
|
667
|
+
* @description Payload for bulk registration of loggers discovered by an SDK.
|
|
591
668
|
* @example {
|
|
592
669
|
* "loggers": [
|
|
593
670
|
* {
|
|
@@ -606,26 +683,48 @@ interface components$1 {
|
|
|
606
683
|
* }
|
|
607
684
|
*/
|
|
608
685
|
LoggerBulkRequest: {
|
|
609
|
-
/**
|
|
686
|
+
/**
|
|
687
|
+
* Loggers
|
|
688
|
+
* @description Loggers to register or refresh observations for.
|
|
689
|
+
*/
|
|
610
690
|
loggers: components$1["schemas"]["LoggerBulkItem"][];
|
|
611
691
|
};
|
|
612
692
|
/**
|
|
613
693
|
* LoggerBulkResponse
|
|
694
|
+
* @description Result of a bulk registration call.
|
|
614
695
|
* @example {
|
|
615
696
|
* "registered": 5
|
|
616
697
|
* }
|
|
617
698
|
*/
|
|
618
699
|
LoggerBulkResponse: {
|
|
619
|
-
/**
|
|
700
|
+
/**
|
|
701
|
+
* Registered
|
|
702
|
+
* @description Number of loggers that were created or had a source observation refreshed.
|
|
703
|
+
*/
|
|
620
704
|
registered: number;
|
|
621
705
|
};
|
|
622
|
-
/**
|
|
706
|
+
/**
|
|
707
|
+
* LoggerListResponse
|
|
708
|
+
* @description JSON:API collection response for loggers.
|
|
709
|
+
*/
|
|
623
710
|
LoggerListResponse: {
|
|
624
711
|
/** Data */
|
|
625
712
|
data: components$1["schemas"]["LoggerResource"][];
|
|
626
713
|
};
|
|
714
|
+
/**
|
|
715
|
+
* LoggerRequest
|
|
716
|
+
* @description JSON:API request envelope for creating or updating a logger.
|
|
717
|
+
*/
|
|
718
|
+
LoggerRequest: {
|
|
719
|
+
data: components$1["schemas"]["LoggerResource"];
|
|
720
|
+
};
|
|
627
721
|
/**
|
|
628
722
|
* LoggerResource
|
|
723
|
+
* @description JSON:API resource envelope for a logger.
|
|
724
|
+
*
|
|
725
|
+
* `id` is the logger's dot-separated key (e.g. `sqlalchemy.engine`).
|
|
726
|
+
* On a `PUT /api/v1/loggers/{id}` create, the id is taken from the URL
|
|
727
|
+
* path; on update, an `id` in the body renames the logger.
|
|
629
728
|
* @example {
|
|
630
729
|
* "attributes": {
|
|
631
730
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
@@ -657,12 +756,20 @@ interface components$1 {
|
|
|
657
756
|
type: "logger";
|
|
658
757
|
attributes: components$1["schemas"]["Logger"];
|
|
659
758
|
};
|
|
660
|
-
/**
|
|
759
|
+
/**
|
|
760
|
+
* LoggerResponse
|
|
761
|
+
* @description JSON:API single-resource response envelope for a logger.
|
|
762
|
+
*/
|
|
661
763
|
LoggerResponse: {
|
|
662
764
|
data: components$1["schemas"]["LoggerResource"];
|
|
663
765
|
};
|
|
664
766
|
/**
|
|
665
767
|
* LoggerSource
|
|
768
|
+
* @description A single service / environment observation of a logger.
|
|
769
|
+
*
|
|
770
|
+
* A source row exists for every (service, environment) pair that has
|
|
771
|
+
* reported the logger via the bulk registration endpoint. The row's
|
|
772
|
+
* levels reflect what the SDK saw on the most recent report.
|
|
666
773
|
* @example {
|
|
667
774
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
668
775
|
* "environment": "production",
|
|
@@ -674,30 +781,58 @@ interface components$1 {
|
|
|
674
781
|
* }
|
|
675
782
|
*/
|
|
676
783
|
LoggerSource: {
|
|
677
|
-
/**
|
|
784
|
+
/**
|
|
785
|
+
* Service
|
|
786
|
+
* @description Service that reported the logger.
|
|
787
|
+
*/
|
|
678
788
|
readonly service?: string;
|
|
679
|
-
/**
|
|
789
|
+
/**
|
|
790
|
+
* Environment
|
|
791
|
+
* @description Environment the service was running in when it reported the logger.
|
|
792
|
+
*/
|
|
680
793
|
readonly environment?: string;
|
|
681
|
-
/**
|
|
794
|
+
/**
|
|
795
|
+
* Level
|
|
796
|
+
* @description Level explicitly set on the logger in the source runtime. `null` when the runtime inherits its level.
|
|
797
|
+
*/
|
|
682
798
|
readonly level?: string | null;
|
|
683
|
-
/**
|
|
799
|
+
/**
|
|
800
|
+
* Resolved Level
|
|
801
|
+
* @description Effective level the runtime resolved for the logger.
|
|
802
|
+
*/
|
|
684
803
|
readonly resolved_level?: string;
|
|
685
|
-
/**
|
|
804
|
+
/**
|
|
805
|
+
* First Observed
|
|
806
|
+
* @description When this service / environment combination first reported the logger.
|
|
807
|
+
*/
|
|
686
808
|
readonly first_observed?: string | null;
|
|
687
|
-
/**
|
|
809
|
+
/**
|
|
810
|
+
* Last Seen
|
|
811
|
+
* @description Most recent report received for this service / environment combination.
|
|
812
|
+
*/
|
|
688
813
|
readonly last_seen?: string | null;
|
|
689
|
-
/**
|
|
814
|
+
/**
|
|
815
|
+
* Created At
|
|
816
|
+
* @description When the source row was created.
|
|
817
|
+
*/
|
|
690
818
|
readonly created_at?: string | null;
|
|
691
|
-
/**
|
|
819
|
+
/**
|
|
820
|
+
* Updated At
|
|
821
|
+
* @description When the source row was last refreshed.
|
|
822
|
+
*/
|
|
692
823
|
readonly updated_at?: string | null;
|
|
693
824
|
};
|
|
694
|
-
/**
|
|
825
|
+
/**
|
|
826
|
+
* LoggerSourceListResponse
|
|
827
|
+
* @description JSON:API collection response for logger sources.
|
|
828
|
+
*/
|
|
695
829
|
LoggerSourceListResponse: {
|
|
696
830
|
/** Data */
|
|
697
831
|
data: components$1["schemas"]["LoggerSourceResource"][];
|
|
698
832
|
};
|
|
699
833
|
/**
|
|
700
834
|
* LoggerSourceResource
|
|
835
|
+
* @description JSON:API resource envelope for a logger source observation.
|
|
701
836
|
* @example {
|
|
702
837
|
* "attributes": {
|
|
703
838
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
@@ -722,15 +857,27 @@ interface components$1 {
|
|
|
722
857
|
type: "logger_source";
|
|
723
858
|
attributes: components$1["schemas"]["LoggerSource"];
|
|
724
859
|
};
|
|
725
|
-
/**
|
|
860
|
+
/**
|
|
861
|
+
* ServiceAttributes
|
|
862
|
+
* @description A discovered service has no attributes beyond its name (the `id`).
|
|
863
|
+
*/
|
|
726
864
|
ServiceAttributes: Record<string, never>;
|
|
727
|
-
/**
|
|
865
|
+
/**
|
|
866
|
+
* ServiceListResponse
|
|
867
|
+
* @description JSON:API collection response for discovered services.
|
|
868
|
+
*/
|
|
728
869
|
ServiceListResponse: {
|
|
729
870
|
/** Data */
|
|
730
871
|
data: components$1["schemas"]["ServiceResource"][];
|
|
731
872
|
};
|
|
732
873
|
/**
|
|
733
874
|
* ServiceResource
|
|
875
|
+
* @description JSON:API resource envelope for a discovered service.
|
|
876
|
+
*
|
|
877
|
+
* `id` is the service name as reported by an SDK during bulk
|
|
878
|
+
* registration. The resource carries no additional attributes — it
|
|
879
|
+
* represents the existence of the service in the account's
|
|
880
|
+
* observations, nothing more.
|
|
734
881
|
* @example {
|
|
735
882
|
* "attributes": {},
|
|
736
883
|
* "id": "api-gateway",
|
|
@@ -748,17 +895,30 @@ interface components$1 {
|
|
|
748
895
|
/** @default {} */
|
|
749
896
|
attributes: components$1["schemas"]["ServiceAttributes"];
|
|
750
897
|
};
|
|
751
|
-
/**
|
|
898
|
+
/**
|
|
899
|
+
* UsageAttributes
|
|
900
|
+
* @description Usage counter for a single metered limit.
|
|
901
|
+
*/
|
|
752
902
|
UsageAttributes: {
|
|
753
|
-
/**
|
|
903
|
+
/**
|
|
904
|
+
* Limit Key
|
|
905
|
+
* @description Identifier of the metered limit, e.g. `logging.managed_loggers` or `logging.groups`.
|
|
906
|
+
*/
|
|
754
907
|
limit_key: string;
|
|
755
|
-
/**
|
|
908
|
+
/**
|
|
909
|
+
* Period
|
|
910
|
+
* @description Period the counter covers. `current` is the only supported value.
|
|
911
|
+
*/
|
|
756
912
|
period: string;
|
|
757
|
-
/**
|
|
913
|
+
/**
|
|
914
|
+
* Value
|
|
915
|
+
* @description Count for the period.
|
|
916
|
+
*/
|
|
758
917
|
value: number;
|
|
759
918
|
};
|
|
760
919
|
/**
|
|
761
920
|
* UsageListResponse
|
|
921
|
+
* @description JSON:API collection response for usage counters.
|
|
762
922
|
* @example {
|
|
763
923
|
* "data": [
|
|
764
924
|
* {
|
|
@@ -788,6 +948,7 @@ interface components$1 {
|
|
|
788
948
|
};
|
|
789
949
|
/**
|
|
790
950
|
* UsageResource
|
|
951
|
+
* @description JSON:API resource envelope for a single usage counter.
|
|
791
952
|
* @example {
|
|
792
953
|
* "attributes": {
|
|
793
954
|
* "limit_key": "logging.managed_loggers",
|
package/dist/index.d.ts
CHANGED
|
@@ -439,6 +439,11 @@ interface components$1 {
|
|
|
439
439
|
};
|
|
440
440
|
/**
|
|
441
441
|
* LogGroup
|
|
442
|
+
* @description A named collection of loggers that share a level configuration.
|
|
443
|
+
*
|
|
444
|
+
* Assigning a logger to a group ties the logger's effective level to
|
|
445
|
+
* the group's level (and per-environment overrides). Loggers can move
|
|
446
|
+
* between groups or be detached from a group entirely.
|
|
442
447
|
* @example {
|
|
443
448
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
444
449
|
* "environments": {
|
|
@@ -452,28 +457,61 @@ interface components$1 {
|
|
|
452
457
|
* }
|
|
453
458
|
*/
|
|
454
459
|
LogGroup: {
|
|
455
|
-
/**
|
|
460
|
+
/**
|
|
461
|
+
* Name
|
|
462
|
+
* @description Human-readable label for the group.
|
|
463
|
+
*/
|
|
456
464
|
name: string;
|
|
457
|
-
/**
|
|
458
|
-
|
|
459
|
-
|
|
465
|
+
/**
|
|
466
|
+
* Level
|
|
467
|
+
* @description Default level applied to every logger in the group. `null` leaves member loggers to inherit from elsewhere.
|
|
468
|
+
*/
|
|
469
|
+
level?: ("TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL" | "SILENT") | null;
|
|
470
|
+
/**
|
|
471
|
+
* Parent Id
|
|
472
|
+
* @description Reserved for nested groups. Must be `null` in this version; nested groups are not yet supported.
|
|
473
|
+
*/
|
|
460
474
|
parent_id?: string | null;
|
|
461
|
-
/**
|
|
475
|
+
/**
|
|
476
|
+
* Environments
|
|
477
|
+
* @description Per-environment level overrides keyed by environment name. Each value is an object with an optional `level` field, e.g. `{"production": {"level": "ERROR"}}`. Member loggers inherit the per-environment level unless they set their own override.
|
|
478
|
+
*/
|
|
462
479
|
environments?: {
|
|
463
480
|
[key: string]: unknown;
|
|
464
481
|
} | null;
|
|
465
|
-
/**
|
|
482
|
+
/**
|
|
483
|
+
* Created At
|
|
484
|
+
* @description When the group was created.
|
|
485
|
+
*/
|
|
466
486
|
readonly created_at?: string | null;
|
|
467
|
-
/**
|
|
487
|
+
/**
|
|
488
|
+
* Updated At
|
|
489
|
+
* @description When the group was last modified.
|
|
490
|
+
*/
|
|
468
491
|
readonly updated_at?: string | null;
|
|
469
492
|
};
|
|
470
|
-
/**
|
|
493
|
+
/**
|
|
494
|
+
* LogGroupListResponse
|
|
495
|
+
* @description JSON:API collection response for log groups.
|
|
496
|
+
*/
|
|
471
497
|
LogGroupListResponse: {
|
|
472
498
|
/** Data */
|
|
473
499
|
data: components$1["schemas"]["LogGroupResource"][];
|
|
474
500
|
};
|
|
501
|
+
/**
|
|
502
|
+
* LogGroupRequest
|
|
503
|
+
* @description JSON:API request envelope for creating or updating a log group.
|
|
504
|
+
*/
|
|
505
|
+
LogGroupRequest: {
|
|
506
|
+
data: components$1["schemas"]["LogGroupResource"];
|
|
507
|
+
};
|
|
475
508
|
/**
|
|
476
509
|
* LogGroupResource
|
|
510
|
+
* @description JSON:API resource envelope for a log group.
|
|
511
|
+
*
|
|
512
|
+
* `id` is the group's key (e.g. `database-loggers`). On a create
|
|
513
|
+
* request the id may be supplied; if omitted, the server generates
|
|
514
|
+
* one from `name`.
|
|
477
515
|
* @example {
|
|
478
516
|
* "attributes": {
|
|
479
517
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
@@ -500,12 +538,22 @@ interface components$1 {
|
|
|
500
538
|
type: "log_group";
|
|
501
539
|
attributes: components$1["schemas"]["LogGroup"];
|
|
502
540
|
};
|
|
503
|
-
/**
|
|
541
|
+
/**
|
|
542
|
+
* LogGroupResponse
|
|
543
|
+
* @description JSON:API single-resource response envelope for a log group.
|
|
544
|
+
*/
|
|
504
545
|
LogGroupResponse: {
|
|
505
546
|
data: components$1["schemas"]["LogGroupResource"];
|
|
506
547
|
};
|
|
507
548
|
/**
|
|
508
549
|
* Logger
|
|
550
|
+
* @description A logger configured for the account.
|
|
551
|
+
*
|
|
552
|
+
* Loggers are organized by dot-separated key (for example, `sqlalchemy.engine`),
|
|
553
|
+
* matching the hierarchical naming convention used by most logging
|
|
554
|
+
* frameworks. A managed logger applies the configured level to every
|
|
555
|
+
* runtime where the logger appears; unmanaged loggers are tracked only
|
|
556
|
+
* as observations from SDKs.
|
|
509
557
|
* @example {
|
|
510
558
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
511
559
|
* "environments": {
|
|
@@ -524,33 +572,61 @@ interface components$1 {
|
|
|
524
572
|
* }
|
|
525
573
|
*/
|
|
526
574
|
Logger: {
|
|
527
|
-
/**
|
|
575
|
+
/**
|
|
576
|
+
* Name
|
|
577
|
+
* @description Human-readable label for the logger.
|
|
578
|
+
*/
|
|
528
579
|
name: string;
|
|
529
|
-
/**
|
|
530
|
-
|
|
531
|
-
|
|
580
|
+
/**
|
|
581
|
+
* Level
|
|
582
|
+
* @description Account-wide log level applied to this logger. `null` means no override at the logger level — the level is inherited from the logger's group or the framework default.
|
|
583
|
+
*/
|
|
584
|
+
level?: ("TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL" | "SILENT") | null;
|
|
585
|
+
/**
|
|
586
|
+
* Group
|
|
587
|
+
* @description Key of the log group this logger belongs to, or `null` if the logger is not grouped. Assigning a logger to a group promotes it to managed; assigning a group cascades to unmanaged descendants by clearing their group reference.
|
|
588
|
+
*/
|
|
532
589
|
group?: string | null;
|
|
533
|
-
/**
|
|
590
|
+
/**
|
|
591
|
+
* Managed
|
|
592
|
+
* @description When `true`, the logger is part of the account's managed configuration and counts toward the managed-loggers usage counter. Setting `level`, `group`, or `environments` on an unmanaged logger promotes it to managed automatically.
|
|
593
|
+
*/
|
|
534
594
|
managed?: boolean | null;
|
|
535
|
-
/**
|
|
595
|
+
/**
|
|
596
|
+
* Sources
|
|
597
|
+
* @description Service / environment observations reported by SDKs for this logger. Each entry carries the service name, environment, the level the SDK saw, the resolved level after framework inheritance, and timestamps for the first and most recent sighting.
|
|
598
|
+
*/
|
|
536
599
|
readonly sources?: {
|
|
537
600
|
[key: string]: unknown;
|
|
538
601
|
}[] | null;
|
|
539
|
-
/**
|
|
602
|
+
/**
|
|
603
|
+
* Environments
|
|
604
|
+
* @description Per-environment level overrides keyed by environment name. Each value is an object with an optional `level` field, e.g. `{"production": {"level": "WARN"}}`. An environment may be present with no `level` to record that the logger applies there without changing the resolved level.
|
|
605
|
+
*/
|
|
540
606
|
environments?: {
|
|
541
607
|
[key: string]: unknown;
|
|
542
608
|
} | null;
|
|
543
|
-
/**
|
|
609
|
+
/**
|
|
610
|
+
* Effective Levels
|
|
611
|
+
* @description Per-environment summary of what runtimes are reporting for this logger. Keyed by environment name; each entry is one of `{"status": "none"}`, `{"status": "agrees", "level": "<LEVEL>"}`, or `{"status": "varies"}`. `agrees` means every observed source in that environment reports the same resolved level; `varies` means at least two sources disagree.
|
|
612
|
+
*/
|
|
544
613
|
readonly effective_levels?: {
|
|
545
614
|
[key: string]: unknown;
|
|
546
615
|
} | null;
|
|
547
|
-
/**
|
|
616
|
+
/**
|
|
617
|
+
* Created At
|
|
618
|
+
* @description When the logger was first created or discovered.
|
|
619
|
+
*/
|
|
548
620
|
readonly created_at?: string | null;
|
|
549
|
-
/**
|
|
621
|
+
/**
|
|
622
|
+
* Updated At
|
|
623
|
+
* @description When the logger was last modified.
|
|
624
|
+
*/
|
|
550
625
|
readonly updated_at?: string | null;
|
|
551
626
|
};
|
|
552
627
|
/**
|
|
553
628
|
* LoggerBulkItem
|
|
629
|
+
* @description One logger discovered by an SDK during a bulk registration call.
|
|
554
630
|
* @example {
|
|
555
631
|
* "environment": "production",
|
|
556
632
|
* "id": "sqlalchemy.engine",
|
|
@@ -562,32 +638,33 @@ interface components$1 {
|
|
|
562
638
|
LoggerBulkItem: {
|
|
563
639
|
/**
|
|
564
640
|
* Id
|
|
565
|
-
* @description
|
|
641
|
+
* @description Dot-separated logger key as the SDK saw it.
|
|
566
642
|
*/
|
|
567
643
|
id: string;
|
|
568
644
|
/**
|
|
569
645
|
* Level
|
|
570
|
-
* @description
|
|
646
|
+
* @description Level explicitly set on the logger by application code. `null` when the level is inherited.
|
|
571
647
|
*/
|
|
572
648
|
level?: string | null;
|
|
573
649
|
/**
|
|
574
650
|
* Resolved Level
|
|
575
|
-
* @description
|
|
651
|
+
* @description Effective level after framework inheritance. SDKs should always report this; the server falls back to `level` when `resolved_level` is missing.
|
|
576
652
|
*/
|
|
577
653
|
resolved_level?: string | null;
|
|
578
654
|
/**
|
|
579
655
|
* Service
|
|
580
|
-
* @description Service name that
|
|
656
|
+
* @description Service name that observed the logger.
|
|
581
657
|
*/
|
|
582
658
|
service?: string | null;
|
|
583
659
|
/**
|
|
584
660
|
* Environment
|
|
585
|
-
* @description Environment where
|
|
661
|
+
* @description Environment where the logger was observed.
|
|
586
662
|
*/
|
|
587
663
|
environment?: string | null;
|
|
588
664
|
};
|
|
589
665
|
/**
|
|
590
666
|
* LoggerBulkRequest
|
|
667
|
+
* @description Payload for bulk registration of loggers discovered by an SDK.
|
|
591
668
|
* @example {
|
|
592
669
|
* "loggers": [
|
|
593
670
|
* {
|
|
@@ -606,26 +683,48 @@ interface components$1 {
|
|
|
606
683
|
* }
|
|
607
684
|
*/
|
|
608
685
|
LoggerBulkRequest: {
|
|
609
|
-
/**
|
|
686
|
+
/**
|
|
687
|
+
* Loggers
|
|
688
|
+
* @description Loggers to register or refresh observations for.
|
|
689
|
+
*/
|
|
610
690
|
loggers: components$1["schemas"]["LoggerBulkItem"][];
|
|
611
691
|
};
|
|
612
692
|
/**
|
|
613
693
|
* LoggerBulkResponse
|
|
694
|
+
* @description Result of a bulk registration call.
|
|
614
695
|
* @example {
|
|
615
696
|
* "registered": 5
|
|
616
697
|
* }
|
|
617
698
|
*/
|
|
618
699
|
LoggerBulkResponse: {
|
|
619
|
-
/**
|
|
700
|
+
/**
|
|
701
|
+
* Registered
|
|
702
|
+
* @description Number of loggers that were created or had a source observation refreshed.
|
|
703
|
+
*/
|
|
620
704
|
registered: number;
|
|
621
705
|
};
|
|
622
|
-
/**
|
|
706
|
+
/**
|
|
707
|
+
* LoggerListResponse
|
|
708
|
+
* @description JSON:API collection response for loggers.
|
|
709
|
+
*/
|
|
623
710
|
LoggerListResponse: {
|
|
624
711
|
/** Data */
|
|
625
712
|
data: components$1["schemas"]["LoggerResource"][];
|
|
626
713
|
};
|
|
714
|
+
/**
|
|
715
|
+
* LoggerRequest
|
|
716
|
+
* @description JSON:API request envelope for creating or updating a logger.
|
|
717
|
+
*/
|
|
718
|
+
LoggerRequest: {
|
|
719
|
+
data: components$1["schemas"]["LoggerResource"];
|
|
720
|
+
};
|
|
627
721
|
/**
|
|
628
722
|
* LoggerResource
|
|
723
|
+
* @description JSON:API resource envelope for a logger.
|
|
724
|
+
*
|
|
725
|
+
* `id` is the logger's dot-separated key (e.g. `sqlalchemy.engine`).
|
|
726
|
+
* On a `PUT /api/v1/loggers/{id}` create, the id is taken from the URL
|
|
727
|
+
* path; on update, an `id` in the body renames the logger.
|
|
629
728
|
* @example {
|
|
630
729
|
* "attributes": {
|
|
631
730
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
@@ -657,12 +756,20 @@ interface components$1 {
|
|
|
657
756
|
type: "logger";
|
|
658
757
|
attributes: components$1["schemas"]["Logger"];
|
|
659
758
|
};
|
|
660
|
-
/**
|
|
759
|
+
/**
|
|
760
|
+
* LoggerResponse
|
|
761
|
+
* @description JSON:API single-resource response envelope for a logger.
|
|
762
|
+
*/
|
|
661
763
|
LoggerResponse: {
|
|
662
764
|
data: components$1["schemas"]["LoggerResource"];
|
|
663
765
|
};
|
|
664
766
|
/**
|
|
665
767
|
* LoggerSource
|
|
768
|
+
* @description A single service / environment observation of a logger.
|
|
769
|
+
*
|
|
770
|
+
* A source row exists for every (service, environment) pair that has
|
|
771
|
+
* reported the logger via the bulk registration endpoint. The row's
|
|
772
|
+
* levels reflect what the SDK saw on the most recent report.
|
|
666
773
|
* @example {
|
|
667
774
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
668
775
|
* "environment": "production",
|
|
@@ -674,30 +781,58 @@ interface components$1 {
|
|
|
674
781
|
* }
|
|
675
782
|
*/
|
|
676
783
|
LoggerSource: {
|
|
677
|
-
/**
|
|
784
|
+
/**
|
|
785
|
+
* Service
|
|
786
|
+
* @description Service that reported the logger.
|
|
787
|
+
*/
|
|
678
788
|
readonly service?: string;
|
|
679
|
-
/**
|
|
789
|
+
/**
|
|
790
|
+
* Environment
|
|
791
|
+
* @description Environment the service was running in when it reported the logger.
|
|
792
|
+
*/
|
|
680
793
|
readonly environment?: string;
|
|
681
|
-
/**
|
|
794
|
+
/**
|
|
795
|
+
* Level
|
|
796
|
+
* @description Level explicitly set on the logger in the source runtime. `null` when the runtime inherits its level.
|
|
797
|
+
*/
|
|
682
798
|
readonly level?: string | null;
|
|
683
|
-
/**
|
|
799
|
+
/**
|
|
800
|
+
* Resolved Level
|
|
801
|
+
* @description Effective level the runtime resolved for the logger.
|
|
802
|
+
*/
|
|
684
803
|
readonly resolved_level?: string;
|
|
685
|
-
/**
|
|
804
|
+
/**
|
|
805
|
+
* First Observed
|
|
806
|
+
* @description When this service / environment combination first reported the logger.
|
|
807
|
+
*/
|
|
686
808
|
readonly first_observed?: string | null;
|
|
687
|
-
/**
|
|
809
|
+
/**
|
|
810
|
+
* Last Seen
|
|
811
|
+
* @description Most recent report received for this service / environment combination.
|
|
812
|
+
*/
|
|
688
813
|
readonly last_seen?: string | null;
|
|
689
|
-
/**
|
|
814
|
+
/**
|
|
815
|
+
* Created At
|
|
816
|
+
* @description When the source row was created.
|
|
817
|
+
*/
|
|
690
818
|
readonly created_at?: string | null;
|
|
691
|
-
/**
|
|
819
|
+
/**
|
|
820
|
+
* Updated At
|
|
821
|
+
* @description When the source row was last refreshed.
|
|
822
|
+
*/
|
|
692
823
|
readonly updated_at?: string | null;
|
|
693
824
|
};
|
|
694
|
-
/**
|
|
825
|
+
/**
|
|
826
|
+
* LoggerSourceListResponse
|
|
827
|
+
* @description JSON:API collection response for logger sources.
|
|
828
|
+
*/
|
|
695
829
|
LoggerSourceListResponse: {
|
|
696
830
|
/** Data */
|
|
697
831
|
data: components$1["schemas"]["LoggerSourceResource"][];
|
|
698
832
|
};
|
|
699
833
|
/**
|
|
700
834
|
* LoggerSourceResource
|
|
835
|
+
* @description JSON:API resource envelope for a logger source observation.
|
|
701
836
|
* @example {
|
|
702
837
|
* "attributes": {
|
|
703
838
|
* "created_at": "2026-04-01T10:00:00Z",
|
|
@@ -722,15 +857,27 @@ interface components$1 {
|
|
|
722
857
|
type: "logger_source";
|
|
723
858
|
attributes: components$1["schemas"]["LoggerSource"];
|
|
724
859
|
};
|
|
725
|
-
/**
|
|
860
|
+
/**
|
|
861
|
+
* ServiceAttributes
|
|
862
|
+
* @description A discovered service has no attributes beyond its name (the `id`).
|
|
863
|
+
*/
|
|
726
864
|
ServiceAttributes: Record<string, never>;
|
|
727
|
-
/**
|
|
865
|
+
/**
|
|
866
|
+
* ServiceListResponse
|
|
867
|
+
* @description JSON:API collection response for discovered services.
|
|
868
|
+
*/
|
|
728
869
|
ServiceListResponse: {
|
|
729
870
|
/** Data */
|
|
730
871
|
data: components$1["schemas"]["ServiceResource"][];
|
|
731
872
|
};
|
|
732
873
|
/**
|
|
733
874
|
* ServiceResource
|
|
875
|
+
* @description JSON:API resource envelope for a discovered service.
|
|
876
|
+
*
|
|
877
|
+
* `id` is the service name as reported by an SDK during bulk
|
|
878
|
+
* registration. The resource carries no additional attributes — it
|
|
879
|
+
* represents the existence of the service in the account's
|
|
880
|
+
* observations, nothing more.
|
|
734
881
|
* @example {
|
|
735
882
|
* "attributes": {},
|
|
736
883
|
* "id": "api-gateway",
|
|
@@ -748,17 +895,30 @@ interface components$1 {
|
|
|
748
895
|
/** @default {} */
|
|
749
896
|
attributes: components$1["schemas"]["ServiceAttributes"];
|
|
750
897
|
};
|
|
751
|
-
/**
|
|
898
|
+
/**
|
|
899
|
+
* UsageAttributes
|
|
900
|
+
* @description Usage counter for a single metered limit.
|
|
901
|
+
*/
|
|
752
902
|
UsageAttributes: {
|
|
753
|
-
/**
|
|
903
|
+
/**
|
|
904
|
+
* Limit Key
|
|
905
|
+
* @description Identifier of the metered limit, e.g. `logging.managed_loggers` or `logging.groups`.
|
|
906
|
+
*/
|
|
754
907
|
limit_key: string;
|
|
755
|
-
/**
|
|
908
|
+
/**
|
|
909
|
+
* Period
|
|
910
|
+
* @description Period the counter covers. `current` is the only supported value.
|
|
911
|
+
*/
|
|
756
912
|
period: string;
|
|
757
|
-
/**
|
|
913
|
+
/**
|
|
914
|
+
* Value
|
|
915
|
+
* @description Count for the period.
|
|
916
|
+
*/
|
|
758
917
|
value: number;
|
|
759
918
|
};
|
|
760
919
|
/**
|
|
761
920
|
* UsageListResponse
|
|
921
|
+
* @description JSON:API collection response for usage counters.
|
|
762
922
|
* @example {
|
|
763
923
|
* "data": [
|
|
764
924
|
* {
|
|
@@ -788,6 +948,7 @@ interface components$1 {
|
|
|
788
948
|
};
|
|
789
949
|
/**
|
|
790
950
|
* UsageResource
|
|
951
|
+
* @description JSON:API resource envelope for a single usage counter.
|
|
791
952
|
* @example {
|
|
792
953
|
* "attributes": {
|
|
793
954
|
* "limit_key": "logging.managed_loggers",
|