Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/paketo-buildpacks/google-stackdriver

A Cloud Native Buildpack that contributes Stackdriver agents and configures them to connect to the service
https://github.com/paketo-buildpacks/google-stackdriver

cnb google-stackdriver jvm-applications nodejs-applications

Last synced: about 1 month ago
JSON representation

A Cloud Native Buildpack that contributes Stackdriver agents and configures them to connect to the service

Awesome Lists containing this project

README

        

# `gcr.io/paketo-buildpacks/google-stackdriver`

The Paketo Buildpack for Google Stackdriver is a Cloud Native Buildpack that contributes Stackdriver profiler agent and configure it to connect to the service.

## Behavior

This buildpack will participate if any of the following conditions are met

* A binding exists with `type` of `StackdriverProfiler`

The buildpack will do the following for Java applications:

* If `StackdriverProfiler` binding exists contributes a Java profiler agent to a layer and configures `$JAVA_TOOL_OPTIONS` to use it
* Sets `$GOOGLE_APPLICATION_CREDENTIALS` to the path of the `ApplicationCredentials` secret

The buildpack will do the following for NodeJS applications:

* If `StackdriverProfiler` binding exists
* Contributes a NodeJS profiler agent to a layer and configures `$NODE_MODULES` to use it
* If main module does not already require `@google-cloud/profiler` module, prepends the main module with `require('@google-cloud/profiler').start();`
* Sets `$GOOGLE_APPLICATION_CREDENTIALS` to the path of the `ApplicationCredentials` secret

## Notes

While this buildpack is packaged to support ARM64 there are no upstream bindings for Aternity on ARM64. If you try to use this buildpack on ARM64 it will fail attempting to download ARM64 binaries that do not exist. Please contact the vendor if you'd like to see ARM64 support. The buildpack is positioned to support it as soon as it is available upstream.

## Configuration

| Environment Variable | Description |
| ------------------------------------ | --------------------------------------------------------------------- |
| `$BPL_GOOGLE_STACKDRIVER_MODULE` | Configure the name of the application. Defaults to `default-module`. |
| `$BPL_GOOGLE_STACKDRIVER_PROJECT_ID` | Configure the project id for the application. Defaults to ``. |
| `$BPL_GOOGLE_STACKDRIVER_VERSION` | Configure the version of the application. Defaults to ``. |

## Bindings

The buildpack optionally accepts the following bindings:

### Type: `dependency-mapping`

| Key | Value | Description |
| --------------------- | ------- | ------------------------------------------------------------------------------------------------- |
| `` | `` | If needed, the buildpack will fetch the dependency with digest `` from `` |

## License

This buildpack is released under version 2.0 of the [Apache License][a].

[a]: http://www.apache.org/licenses/LICENSE-2.0