Add bash based metrics collection #1635
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If the env var is missing or the file does not exist, print that information.
Simplifies calling metrics functions inside of bash functions, and it's relatively small.
```
Run shellcheck bin/support/bash_functions.sh bin/support/download_ruby -x &&
In bin/support/bash_functions.sh line 234:
local timestamp=$(date +%s%3N 2>/dev/null)
^-------^ SC2155 (warning): Declare and assign separately to avoid masking return values.
In bin/support/bash_functions.sh line 243:
local seconds=$(date +%s)
^-----^ SC2155 (warning): Declare and assign separately to avoid masking return values.
In bin/support/bash_functions.sh line 244:
local nanoseconds=$(date +%N 2>/dev/null || echo "000000000")
^---------^ SC2155 (warning): Declare and assign separately to avoid masking return values.
```
```
+remote: Updated 2 paths from 60b426a
+remote: Compressing source files... done.
+remote: Building source:
+remote:
+remote: -----> Building on the Heroku-24 stack
+remote: -----> Using buildpack: https://github.com/heroku/heroku-buildpack-ruby#schneems/bash-metrics-initial
+remote: -----> Ruby app detected
+remote: /tmp/codon/tmp/buildpacks/bc6628ed5814e6d8925d4527655dd8e7dda421f4/bin/support/ruby_compile:14:in `fetch': key not found: "HEROKU_RUBY_BUILD_REPORT_FILE" (KeyError)
+remote: from /tmp/codon/tmp/buildpacks/bc6628ed5814e6d8925d4527655dd8e7dda421f4/bin/support/ruby_compile:14:in `<main>'
+remote: ! Push rejected, failed to compile Ruby app.
+remote:
+remote: ! Push failed
+remote: Verifying deploy...
+remote:
+remote: ! Push rejected to hatchet-t-90251d64ed.
+remote:
+To https://git.heroku.com/hatchet-t-90251d64ed.git
+ ! [remote rejected] HEAD -> main (pre-receive hook declined)
+error: failed to push some refs to 'https://git.heroku.com/hatchet-t-90251d64ed.git'
# ./vendor/bundle/ruby/3.3.0/gems/rspec-support-3.13.4/lib/rspec/support.rb:110:in `block in <module:Support>'
```
```
In bin/compile line 12:
BUILDPACK_DIR=$(cd "$(dirname "$(dirname "${BASH_SOURCE[0]}")")" && pwd)
^-----------^ SC2034 (warning): BUILDPACK_DIR appears unused. Verify use (or export if used externally).
In bin/test line 9:
BUILDPACK_DIR=$(cd "$(dirname "$(dirname "${BASH_SOURCE[0]}")")" && pwd)
^-----------^ SC2034 (warning): BUILDPACK_DIR appears unused. Verify use (or export if used externally).
In bin/test line 15:
metrics::init "${CACHE_DIR}"
^----------^ SC2153 (info): Possible misspelling: CACHE_DIR may not be assigned. Did you mean cache_dir?
In bin/test-compile line 12:
BUILDPACK_DIR=$(cd "$(dirname "$(dirname "${BASH_SOURCE[0]}")")" && pwd)
^-----------^ SC2034 (warning): BUILDPACK_DIR appears unused. Verify use (or export if used externally).
For more information:
https://www.shellcheck.net/wiki/SC2034 -- BUILDPACK_DIR appears unused. Ver...
https://www.shellcheck.net/wiki/SC2153 -- Possible misspelling: CACHE_DIR m...
```
``` $ bin/test BUILD_DIR ENV_DIR ``` https://devcenter.heroku.com/articles/testpack-api
colincasey
approved these changes
Aug 21, 2025
|
|
||
| metrics::quote_string() { | ||
| local value="${1}" | ||
| echo "'${value//\'/\'\'}'" |
There was a problem hiding this comment.
Not sure if this would be handled better in the Ruby integration with this file but you may also want to strip out or replace control chars (see https://github.com/heroku/heroku-buildpack-nodejs/blob/main/bin/report#L41-L54).
There was a problem hiding this comment.
Switched to using Ed's json backend, I think (hope) that takes care of issues like this
The python buildpack was modified to use JSON instead of YAML as it's easier to use `jq` to format and handle issues such as escaping. This preserves the same API, but changes the format and adopts the strategy from heroku/heroku-buildpack-python#1878.
Previously the bash build output helpers were adjusted to emit json. This wires up the Ruby metrics code to be compatible with that change.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The buildpack is split into a bash part that bootstraps ruby and then the Ruby part that does the bulk of the logic. This adds the ability to push metrics to
bin/reportin the bash section for failures that occur during or before the Ruby logic portion is called.GUS-W-19310610