Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Restarts Prometheus subprocess when it crashes #663

Merged
merged 10 commits into from
May 28, 2020
Merged

Restarts Prometheus subprocess when it crashes #663

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a217767
gitignore
mpmcroy May 13, 2020
7a17615
Merge branch 'master' of github.com:Jigsaw-Code/outline-server
mpmcroy May 21, 2020
bfd161f
Merge branch 'master' of github.com:Jigsaw-Code/outline-server
mpmcroy May 26, 2020
b494a0f
Adds logic to restart Prometheus when it crashes
mpmcroy May 27, 2020
322a669
Refactor Prometheus start logic
mpmcroy May 27, 2020
16bb79f
Commit hook fixes
mpmcroy May 27, 2020
a1ee3c0
Addresses review comments
mpmcroy May 28, 2020
194241a
Addresses review comments
mpmcroy May 28, 2020
ae005d7
Merge branch 'master' of github.com:Jigsaw-Code/outline-server
mpmcroy May 28, 2020
37bdd7d
Merge branch 'master' into mpmcroy-prometheus-restart
mpmcroy May 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 19 additions & 12 deletions src/shadowbox/infrastructure/prometheus_scraper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,14 @@ export class PrometheusClient {
}
}

export async function runPrometheusScraper(
args: string[], configFilename: string, configJson: {},
prometheusEndpoint: string): Promise<child_process.ChildProcess> {
mkdirp.sync(path.dirname(configFilename));
export async function startPrometheus(
configFilename: string, configJson: {}, processArgs: string[], endpoint: string) {
await writePrometheusConfigToDisk(configFilename, configJson);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it makes sense to make these two calls in main instead. It feels odd to pass both a config filename and the config contents to a method. The configJson is not really used by spawnPrometheusSubprocess.

Anyway, not important, up to you.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't feel strongly either way about it.

The configFilename is used in the args, so there's kind of a duplication going on.

I would personally keep it as one method (even if the signature isn't that great) so that users don't forget to call writeConfigFile before spawnPromProcess.

await spawnPrometheusSubprocess(processArgs, endpoint);
}

async function writePrometheusConfigToDisk(configFilename: string, configJson: {}) {
await mkdirp.sync(path.dirname(configFilename));
const ymlTxt = jsyaml.safeDump(configJson, {'sortKeys': true});
// Write the file asynchronously to prevent blocking the node thread.
await new Promise((resolve, reject) => {
Expand All @@ -84,29 +88,32 @@ export async function runPrometheusScraper(
}
});
});
const commandArguments = ['--config.file', configFilename];
commandArguments.push(...args);
const runProcess = child_process.spawn('/root/shadowbox/bin/prometheus', commandArguments);
}

async function spawnPrometheusSubprocess(
processArgs: string[], prometheusEndpoint: string): Promise<child_process.ChildProcess> {
logging.info(`Starting Prometheus with args [${processArgs}]`);
const runProcess = child_process.spawn('/root/shadowbox/bin/prometheus', processArgs);
runProcess.on('error', (error) => {
logging.error(`Error spawning prometheus: ${error}`);
logging.error(`Error spawning Prometheus: ${error}`);
});
// TODO(fortuna): Add restart logic.
runProcess.on('exit', (code, signal) => {
logging.info(`prometheus has exited with error. Code: ${code}, Signal: ${signal}`);
logging.error(`Prometheus has exited with error. Code: ${code}, Signal: ${signal}`);
logging.error('Restarting Prometheus...');
spawnPrometheusSubprocess(processArgs, prometheusEndpoint);
});
// TODO(fortuna): Consider saving the output and expose it through the manager service.
runProcess.stdout.pipe(process.stdout);
runProcess.stderr.pipe(process.stderr);
await waitForPrometheusReady(`${prometheusEndpoint}/api/v1/status/flags`);
logging.info('Prometheus is ready!');
return runProcess;
}

async function waitForPrometheusReady(prometheusEndpoint: string) {
logging.debug('Waiting for Prometheus to be ready...');
while (!(await isHttpEndpointHealthy(prometheusEndpoint))) {
await new Promise((resolve) => setTimeout(resolve, 1000));
}
logging.debug('Prometheus is ready');
}

function isHttpEndpointHealthy(endpoint: string): Promise<boolean> {
Expand Down
21 changes: 12 additions & 9 deletions src/shadowbox/server/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import {RealClock} from '../infrastructure/clock';
import {PortProvider} from '../infrastructure/get_port';
import * as json_config from '../infrastructure/json_config';
import * as logging from '../infrastructure/logging';
import {PrometheusClient, runPrometheusScraper} from '../infrastructure/prometheus_scraper';
import {PrometheusClient, startPrometheus} from '../infrastructure/prometheus_scraper';
import {RolloutTracker} from '../infrastructure/rollout';
import {AccessKeyId} from '../model/access_key';

Expand Down Expand Up @@ -146,15 +146,18 @@ async function main() {
if (isReplayProtectionEnabled) {
shadowsocksServer.enableReplayProtection();
}

// Start Prometheus subprocess and wait for it to be up and running.
const prometheusConfigFilename = getPersistentFilename('prometheus/config.yml');
const prometheusTsdbFilename = getPersistentFilename('prometheus/data');
const prometheusEndpoint = `http://${prometheusLocation}`;
// Wait for Prometheus to be up and running.
await runPrometheusScraper(
[
'--storage.tsdb.retention', '31d', '--storage.tsdb.path',
getPersistentFilename('prometheus/data'), '--web.listen-address', prometheusLocation,
'--log.level', verbose ? 'debug' : 'info'
],
getPersistentFilename('prometheus/config.yml'), prometheusConfigJson, prometheusEndpoint);
const prometheusArgs = [
'--config.file', prometheusConfigFilename, '--storage.tsdb.retention.time', '31d',
'--storage.tsdb.path', prometheusTsdbFilename, '--web.listen-address', prometheusLocation,
'--log.level', verbose ? 'debug' : 'info'
];
await startPrometheus(
prometheusConfigFilename, prometheusConfigJson, prometheusArgs, prometheusEndpoint);

const prometheusClient = new PrometheusClient(prometheusEndpoint);
if (!serverConfig.data().portForNewAccessKeys) {
Expand Down