Skip to main content
Version: 2.0 (deprecated)

run-tracker

Tracks and times the execution of a pants run.

Backend: ``

Config section: [run-tracker]

Basic options​

None

Advanced options​

stats_local_json_file​

--run-tracker-stats-local-json-file=<str>
PANTS_RUN_TRACKER_STATS_LOCAL_JSON_FILE
pants.toml
[run-tracker]
stats_local_json_file = <str>
default: None

Write stats to this local json file on run completion.

stats_option_scopes_to_record​

--run-tracker-stats-option-scopes-to-record="['<str>', '<str>', ...]"
PANTS_RUN_TRACKER_STATS_OPTION_SCOPES_TO_RECORD
pants.toml
[run-tracker]
stats_option_scopes_to_record = [
    '<str>',
    '<str>',
    ...,
]
default: []

Option scopes to record in stats on run completion. Options may be selected by joining the scope and the option with a ^ character, i.e. to get option pantsd in the GLOBAL scope, you'd pass GLOBAL^pantsd. Add a '*' to the list to capture all known scopes.

Deprecated options​

num_background_workers​

--run-tracker-num-background-workers=<int>
PANTS_RUN_TRACKER_NUM_BACKGROUND_WORKERS
pants.toml
[run-tracker]
num_background_workers = <int>
default: 64
Deprecated, will be removed in version: 2.1.0.dev0.
RunTracker no longer uses background workers.

Number of threads for background work.

num_foreground_workers​

--run-tracker-num-foreground-workers=<int>
PANTS_RUN_TRACKER_NUM_FOREGROUND_WORKERS
pants.toml
[run-tracker]
num_foreground_workers = <int>
default: 64
Deprecated, will be removed in version: 2.1.0.dev0.
RunTracker no longer uses foreground workers.

Number of threads for foreground work.

stats_upload_timeout​

--run-tracker-stats-upload-timeout=<int>
PANTS_RUN_TRACKER_STATS_UPLOAD_TIMEOUT
pants.toml
[run-tracker]
stats_upload_timeout = <int>
default: 2
Deprecated, will be removed in version: 2.1.0.dev0.
RunTracker no longer directly supports uploading run stats to urls.

Wait at most this many seconds for the stats upload to complete.

stats_upload_urls​

--run-tracker-stats-upload-urls="{'key1': val1, 'key2': val2, ...}"
PANTS_RUN_TRACKER_STATS_UPLOAD_URLS
pants.toml
[run-tracker.stats_upload_urls]
key1 = val1
key2 = val2
...
default: {}
Deprecated, will be removed in version: 2.1.0.dev0.
RunTracker no longer directly supports uploading run stats to urls.

Upload stats to these URLs on run completion. Value is a map from URL to the name of the auth provider the user must auth against in order to upload stats to that URL, or None/empty string if no auth is required. Currently the auth provider name is only used to provide a more helpful error message.

stats_version​

--run-tracker-stats-version=<int>
PANTS_RUN_TRACKER_STATS_VERSION
pants.toml
[run-tracker]
stats_version = <int>
one of: 1, 2
default: 1
Deprecated, will be removed in version: 2.1.0.dev0.
RunTracker no longer directly supports uploading run stats to urls.

Format of stats JSON for uploads and local json file.

None