swift-distributed-actors/Sources/DistributedCluster/Instrumentation/os_signpost/ReceptionistInstrumentation+os_signpost.swift at fe89717ccee87abb36df98b0e0fcd0d7b9d01256 · akbashev/swift-distributed-actors · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Distributed Actors open source project
//
// Copyright (c) 2020 Apple Inc. and the Swift Distributed Actors project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of Swift Distributed Actors project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//

#if canImport(Darwin)
import Foundation
import os.log
import os.signpost

@available(OSX 10.14, *)
@available(iOS 12.0, *)
@available(tvOS 12.0, *)
@available(watchOS 3.0, *)
internal struct OSSignpostReceptionistInstrumentation: _ReceptionistInstrumentation {
    static let subsystem: StaticString = "com.apple.actors"

    static let category: StaticString = "Receptionist"

    static let nameRegistered: StaticString = "Registered"
    static let nameSubscribed: StaticString = "Subscribed"
    static let nameRemoved: StaticString = "Removed"
    static let namePublished: StaticString = "Published"

    static let log = OSLog(subsystem: "\(Self.subsystem)", category: "\(Self.category)")

    init() {}
}

// ==== ----------------------------------------------------------------------------------------------------------------
// MARK: Instrumentation: Receptionist

@available(OSX 10.14, *)
@available(iOS 12.0, *)
@available(tvOS 12.0, *)
@available(watchOS 3.0, *)
extension OSSignpostReceptionistInstrumentation {
    static let subscribedFormat: StaticString =
        """
        sub;\
        key:%{public}s;\
        type:%{public}s
        """

    func actorSubscribed(key: AnyReceptionKey, id: ActorID) {
        guard Self.log.signpostsEnabled else {
            return
        }

        os_signpost(
            .event,
            log: Self.log,
            name: Self.nameSubscribed,
            signpostID: .exclusive,
            Self.subscribedFormat,
            "\(key.id)",
            "\(key.guestType)"
        )
    }

    static let registeredFormat: StaticString =
        """
        reg;\
        key:%{public}s;\
        type:%{public}s
        """

    func actorRegistered(key: AnyReceptionKey, id: ActorID) {
        guard Self.log.signpostsEnabled else {
            return
        }

        os_signpost(
            .event,
            log: Self.log,
            name: Self.nameRegistered,
            signpostID: .exclusive,
            Self.registeredFormat,
            "\(key.id)",
            "\(key.guestType)"
        )
    }

    static let removedFormat: StaticString =
        """
        rm;\
        key:%{public}s;\
        type:%{public}s
        """

    func actorRemoved(key: AnyReceptionKey, id: ActorID) {
        guard Self.log.signpostsEnabled else {
            return
        }

        os_signpost(
            .event,
            log: Self.log,
            name: Self.nameRemoved,
            signpostID: .exclusive,
            Self.removedFormat,
            "\(key.id)",
            "\(key.guestType)"
        )
    }

    static let listingPublishedFormat: StaticString =
        """
        pub;\
        key:%{public}s;\
        type:%{public}s;\
        subs:%{public}ld;\
        regs:%{public}ld
        """

    func listingPublished(key: AnyReceptionKey, subscribers: Int, registrations: Int) {
        guard Self.log.signpostsEnabled else {
            return
        }

        os_signpost(
            .event,
            log: Self.log,
            name: Self.namePublished,
            signpostID: .exclusive,
            Self.listingPublishedFormat,
            "\(key.id)",
            "\(key.guestType)",
            subscribers,
            registrations
        )
    }
}
#endif