Commit 4446775

- "JavaBuildpack::Framework::SkyWalkingAgent"

---

version: 3.+

default_application_name: $(ruby -e "require 'json' ; a = JSON.parse(ENV['VCAP_APPLICATION']);

puts \"#{a['space_name']}:#{a['application_name']}\"")

repository_root: https://java-buildpack.cloudfoundry.org/sky-walking

The SkyWalking Agent Framework causes an application to be automatically configured to work with a bound [SkyWalking Service][] **Note:** This framework is disabled by default.

<table>

<tr>

<td><strong>Detection Criterion</strong></td><td>Existence of a single bound SkyWalking service. The existence of an SkyWalking service defined by the <a href="http://docs.cloudfoundry.org/devguide/deploy-apps/environment-variable.html#VCAP-SERVICES"><code>VCAP_SERVICES</code></a> payload containing a service name, label or tag with <code>sky-walking</code> or <code>skywalking</code> as a substring.

</td>

</tr>

<tr>

<td><strong>Tags</strong></td><td><tt>sky-walking-agent=&lt;version&gt;</tt></td>

</tr>

</table>

Tags are printed to standard output by the buildpack detect script

When binding SkyWalking using a user-provided service, it must have name or tag with `sky-walking` or `skywalking` in it. The credential payload can contain the following entries. **Note:** Credentials marked as "(Optional)" may be required for some versions of the SkyWalking agent. Please see the [SkyWalking Java Agent Configuration Properties][] for the version of the agent used by your application for more details.

| Name | Description

| ---- | -----------

| `application-name` | (Optional) The application's name

| `sample-n-per-3-secs` | (Optional) The number of sampled traces per 3 seconds. Negative number means sample traces as many as possible, most likely 100%

| `span-limit-per-segment` | (Optional) The max amount of spans in a single segment

| `ignore-suffix` | (Optional) Ignore the segments if their operation names start with these suffix

| `open-debugging-class` | (Optional) If true, skywalking agent will save all instrumented classes files in `/debugging` folder.Skywalking team may ask for these files in order to resolve compatible problem

| `servers` | Server addresses .Examples: Single collector：servers="127.0.0.1:8080",Collector cluster：servers="10.2.45.126:8080,10.2.45.127:7600"

| `logging-level` | (Optional) Logging level

For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to [Configuration and Extension][].

The framework can be configured by modifying the [`config/sky_walking_agent.yml`][] file in the buildpack fork. The framework uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.

| Name | Description

| ---- | -----------

| `default_application_name` | This is omitted by default but can be added to specify the application name in the SkyWalking dashboard. This can be overridden by an `application-name` entry in the credentials payload. If neither are supplied the default is the `application_name` as specified by Cloud Foundry.

| `repository_root` | The URL of the SkyWalking repository index ([details][repositories]).

| `version` | The version of SkyWalking to use. Candidate versions can be found in [this listing][].

The framework can also be configured by overlaying a set of resources on the default distribution. To do this, add files to the `resources/sky_walking_agent` directory in the buildpack fork.

[`config/sky_walking_agent.yml`]: ../config/sky_walking_agent.yml

[SkyWalking Java Agent Configuration Properties]: https://github.com/apache/incubator-skywalking/blob/master/docs/en/Deploy-skywalking-agent.md

[SkyWalking Service]: http://skywalking.io

[Configuration and Extension]: ../README.md#configuration-and-extension

[repositories]: extending-repositories.md

[this listing]: https://download.run.pivotal.io/sky-walking/index.yml

[version syntax]: extending-repositories.md#version-syntax-and-ordering

require 'fileutils'

require 'java_buildpack/component/versioned_dependency_component'

require 'java_buildpack/framework'

module JavaBuildpack

module Framework

# Encapsulates the functionality for enabling Sky walking APM support.

class SkyWalkingAgent < JavaBuildpack::Component::VersionedDependencyComponent

# (see JavaBuildpack::Component::BaseComponent#compile)

def compile

download_tar(true, @droplet.sandbox, 'sky_walking_agent')

@droplet.copy_resources

end

# (see JavaBuildpack::Component::BaseComponent#release)

def release

credentials = @application.services.find_service(FILTER, 'servers')['credentials']

java_opts = @droplet.java_opts

java_opts.add_javaagent(@droplet.sandbox + 'skywalking-agent.jar')

application_name java_opts, credentials

sample_n_per_3_secs java_opts, credentials

span_limit_per_segment java_opts, credentials

ignore_suffix java_opts, credentials

open_debugging_class java_opts, credentials

servers java_opts, credentials

logging_level java_opts, credentials

end

protected

# (see JavaBuildpack::Component::VersionedDependencyComponent#supports?)

def supports?

@application.services.one_service? FILTER, 'servers'

end

private

FILTER = /sky[-]?walking/

private_constant :FILTER

def servers(java_opts, credentials)

servers = credentials['servers']

raise "'servers' credential must be set" unless servers

java_opts.add_system_property 'skywalking.collector.servers', servers

end

def application_name(java_opts, credentials)

name = credentials['application-name'] || @configuration['default_application_name'] ||

@application.details['application_name']

java_opts.add_system_property('skywalking.agent.application_code', name.to_s)

end

def sample_n_per_3_secs(java_opts, credentials)

sample_n_per_3_secs = credentials['sample-n-per-3-secs']

java_opts.add_system_property 'skywalking.agent.sample_n_per_3_secs', sample_n_per_3_secs if sample_n_per_3_secs

end

def span_limit_per_segment(java_opts, credentials)

span_lmt_per_seg = credentials['span-limit-per-segment']

java_opts.add_system_property 'skywalking.agent.span_limit_per_segment', span_lmt_per_seg if span_lmt_per_seg

end

def ignore_suffix(java_opts, credentials)

ignore_suffix = credentials['ignore-suffix']

java_opts.add_system_property 'skywalking.agent.ignore_suffix', ignore_suffix if ignore_suffix

end

def open_debugging_class(java_opts, credentials)

is_debug_class = credentials['is-open-debugging-class']

java_opts.add_system_property 'skywalking.agent.is_open_debugging_class', is_debug_class if is_debug_class

end

def logging_level(java_opts, credentials)

logging_level = credentials['logging-level']

java_opts.add_system_property 'skywalking.logging.level', logging_level if logging_level

end

end

end

'geode_store' => 'Geode Tomcat Session Store',

'sky_walking_agent' => 'SkyWalking',

require 'spec_helper'

require 'component_helper'

require 'java_buildpack/framework/sky_walking_agent'

describe JavaBuildpack::Framework::SkyWalkingAgent do

include_context 'with component help'

let(:configuration) do

{ 'default_application_name' => nil }

end

it 'does not detect without skywalking-n/a service' do

expect(component.detect).to be_nil

end

context do

let(:credentials) { {} }

before do

allow(services).to receive(:one_service?).with(/sky[-]?walking/, 'servers').and_return(true)

allow(services).to receive(:find_service).and_return('credentials' => credentials)

end

it 'detects with skywalking-n/a service' do

expect(component.detect).to eq("sky-walking-agent=#{version}")

end

it 'expands Skywalking agent tar',

cache_fixture: 'stub-skywalking-agent.tar.gz' do

component.compile

expect(sandbox + 'skywalking-agent.jar').to exist

end

it 'raises error if servers not specified' do

expect { component.release }.to raise_error(/'servers' credential must be set/)

end

context do

let(:credentials) { { 'servers' => 'test-servers' } }

it 'updates JAVA_OPTS' do

component.release

expect(java_opts).to include('-javaagent:$PWD/.java-buildpack/sky_walking_agent/skywalking-agent.jar')

expect(java_opts).to include('-Dskywalking.collector.servers=test-servers')

expect(java_opts).to include('-Dskywalking.agent.application_code=test-application-name')

end

context do

let(:credentials) { super().merge 'sample-n-per-3-secs' => '10' }

it 'adds sample_n_per_3_secs from credentials to JAVA_OPTS if specified' do

component.release

expect(java_opts).to include('-Dskywalking.agent.sample_n_per_3_secs=10')

end

end

context do

let(:credentials) { super().merge 'application-name' => 'another-test-application-name' }

it 'adds application_name from credentials to JAVA_OPTS if specified' do

component.release

expect(java_opts).to include('-Dskywalking.agent.application_code=another-test-application-name')

end

end

context do

let(:credentials) { super().merge 'span-limit-per-segment' => '300' }

it 'adds span_limit_per_segment from credentials to JAVA_OPTS if specified' do

component.release

expect(java_opts).to include('-Dskywalking.agent.span_limit_per_segment=300')

end

end

context do

let(:credentials) { super().merge 'ignore-suffix' => '.html' }

it 'adds ignore_suffix to JAVA_OPTS if specified' do

component.release

expect(java_opts).to include('-Dskywalking.agent.ignore_suffix=.html')

end

end

context do

let(:credentials) { super().merge 'is-open-debugging-class' => 'true' }

it 'adds is_open_debugging_class to JAVA_OPTS if specified' do

component.release

expect(java_opts).to include('-Dskywalking.agent.is_open_debugging_class=true')

end

end

context do

let(:credentials) { super().merge 'logging-level' => 'DEBUG' }

it 'adds logging_level to JAVA_OPTS if specified' do

component.release

expect(java_opts).to include('-Dskywalking.logging.level=DEBUG')

end

end

end

end