aboutsummaryrefslogtreecommitdiff
path: root/spark-common/src/main/java/me/lucko/spark/common/sampler/BackgroundSamplerManager.java
blob: 4e9ca9e073e7a6ad583d251fd047f20501662c89 (plain)
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
/*
 * This file is part of spark.
 *
 *  Copyright (c) lucko (Luck) <luck@lucko.me>
 *  Copyright (c) contributors
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package me.lucko.spark.common.sampler;

import me.lucko.spark.common.SparkPlatform;
import me.lucko.spark.common.platform.PlatformInfo;
import me.lucko.spark.common.util.Configuration;

import java.util.logging.Level;

public class BackgroundSamplerManager {

    private static final String OPTION_ENABLED = "backgroundProfiler";
    private static final String OPTION_ENGINE = "backgroundProfilerEngine";
    private static final String OPTION_INTERVAL = "backgroundProfilerInterval";
    private static final String OPTION_THREAD_GROUPER = "backgroundProfilerThreadGrouper";
    private static final String OPTION_THREAD_DUMPER = "backgroundProfilerThreadDumper";

    private static final String MARKER_FAILED = "_marker_background_profiler_failed";

    private final SparkPlatform platform;
    private final Configuration configuration;
    private final boolean enabled;

    public BackgroundSamplerManager(SparkPlatform platform, Configuration configuration) {
        this.platform = platform;
        this.configuration = configuration;

        PlatformInfo.Type type = this.platform.getPlugin().getPlatformInfo().getType();
        this.enabled = type != PlatformInfo.Type.CLIENT && this.configuration.getBoolean(OPTION_ENABLED, type == PlatformInfo.Type.SERVER);
    }

    public void initialise() {
        if (!this.enabled) {
            return;
        }

        // are we enabling the background profiler by default for the first time?
        boolean didEnableByDefault = false;
        if (!this.configuration.contains(OPTION_ENABLED)) {
            this.configuration.setBoolean(OPTION_ENABLED, true);
            didEnableByDefault = true;
        }

        // did the background profiler fail to start on the previous attempt?
        if (this.configuration.getBoolean(MARKER_FAILED, false)) {
            this.platform.getPlugin().log(Level.WARNING, "It seems the background profiler failed to start when spark was last enabled. Sorry about that!");
            this.platform.getPlugin().log(Level.WARNING, "In the future, spark will try to use the built-in Java profiling engine instead.");

            this.configuration.remove(MARKER_FAILED);
            this.configuration.setString(OPTION_ENGINE, "java");
            this.configuration.save();
        }

        this.platform.getPlugin().log(Level.INFO, "Starting background profiler...");

        if (didEnableByDefault) {
            // set the failed marker and save before we try to start the profiler,
            // then remove the marker afterwards if everything goes ok!
            this.configuration.setBoolean(MARKER_FAILED, true);
            this.configuration.save();
        }

        try {
            startSampler();

            if (didEnableByDefault) {
                this.configuration.remove(MARKER_FAILED);
                this.configuration.save();
            }

        } catch (Throwable e) {
            e.printStackTrace();
        }
    }

    public boolean restartBackgroundSampler() {
        if (this.enabled) {
            startSampler();
            return true;
        }
        return false;
    }

    private void startSampler() {
        boolean forceJavaEngine = this.configuration.getString(OPTION_ENGINE, "async").equals("java");

        ThreadGrouper threadGrouper = ThreadGrouper.parseConfigSetting(this.configuration.getString(OPTION_THREAD_GROUPER, "by-pool"));
        ThreadDumper threadDumper = ThreadDumper.parseConfigSetting(this.configuration.getString(OPTION_THREAD_DUMPER, "default"));
        if (threadDumper == null) {
            threadDumper = this.platform.getPlugin().getDefaultThreadDumper();
        }

        int interval = this.configuration.getInteger(OPTION_INTERVAL, 10);

        Sampler sampler = new SamplerBuilder()
              .background(true)
              .threadDumper(threadDumper)
              .threadGrouper(threadGrouper)
              .samplingInterval(interval)
              .forceJavaSampler(forceJavaEngine)
              .start(this.platform);

        this.platform.getSamplerContainer().setActiveSampler(sampler);
    }

}