1 | /* |
2 | * Copyright (C) 2014 Apple Inc. All rights reserved. |
3 | * |
4 | * Redistribution and use in source and binary forms, with or without |
5 | * modification, are permitted provided that the following conditions |
6 | * are met: |
7 | * 1. Redistributions of source code must retain the above copyright |
8 | * notice, this list of conditions and the following disclaimer. |
9 | * 2. Redistributions in binary form must reproduce the above copyright |
10 | * notice, this list of conditions and the following disclaimer in the |
11 | * documentation and/or other materials provided with the distribution. |
12 | * |
13 | * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' |
14 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, |
15 | * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
16 | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS |
17 | * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
18 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
19 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
20 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
21 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
22 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
23 | * THE POSSIBILITY OF SUCH DAMAGE. |
24 | */ |
25 | |
26 | #pragma once |
27 | |
28 | #include "DiagnosticLoggingResultType.h" |
29 | #include <wtf/FastMalloc.h> |
30 | #include <wtf/HashMap.h> |
31 | #include <wtf/RandomNumber.h> |
32 | #include <wtf/Variant.h> |
33 | #include <wtf/text/WTFString.h> |
34 | |
35 | namespace WebCore { |
36 | |
37 | enum class ShouldSample : bool { No, Yes }; |
38 | |
39 | class DiagnosticLoggingClient { |
40 | WTF_MAKE_FAST_ALLOCATED; |
41 | public: |
42 | virtual void logDiagnosticMessage(const String& message, const String& description, ShouldSample) = 0; |
43 | virtual void logDiagnosticMessageWithResult(const String& message, const String& description, DiagnosticLoggingResultType, ShouldSample) = 0; |
44 | virtual void logDiagnosticMessageWithValue(const String& message, const String& description, double value, unsigned significantFigures, ShouldSample) = 0; |
45 | virtual void logDiagnosticMessageWithEnhancedPrivacy(const String& message, const String& description, ShouldSample) = 0; |
46 | |
47 | using ValuePayload = Variant<String, uint64_t, int64_t, bool, double>; |
48 | using ValueDictionary = HashMap<String, ValuePayload>; |
49 | |
50 | virtual void logDiagnosticMessageWithValueDictionary(const String& message, const String& description, const ValueDictionary&, ShouldSample) = 0; |
51 | |
52 | static bool shouldLogAfterSampling(ShouldSample); |
53 | |
54 | virtual ~DiagnosticLoggingClient() = default; |
55 | }; |
56 | |
57 | inline bool DiagnosticLoggingClient::shouldLogAfterSampling(ShouldSample shouldSample) |
58 | { |
59 | if (shouldSample == ShouldSample::No) |
60 | return true; |
61 | |
62 | static const double selectionProbability = 0.05; |
63 | return randomNumber() <= selectionProbability; |
64 | } |
65 | |
66 | } // namespace WebCore |
67 | |