Help us shape the future of Go! Take the 2026 Go Developer Survey

frameworks

package
v1.5.2-0...-36bfd17 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 12, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateJavaOptsAssemblyScript 

func CreateJavaOptsAssemblyScript(ctx *common.Context) error

CreateJavaOptsAssemblyScript creates the centralized profile.d script that assembles all JAVA_OPTS This should be called ONCE during finalization (by the finalize coordinator)

func FindFileByPattern 

func FindFileByPattern(baseDir, pattern string, commonSubdirs []string) (string, error)

FindFileByPattern searches for a file matching a glob pattern in a directory. Returns the first matching file or an error if not found.

Parameters:

  • baseDir: The directory to search in
  • pattern: The glob pattern to match (e.g., "contrast*.jar", "sl-test-listener*.jar")
  • commonSubdirs: Optional subdirectories to check first

Example: 

agentPath, err := FindFileByPattern(installDir, "contrast*.jar", []string{""})

func FindFileInDirectory 

func FindFileInDirectory(baseDir, filename string, commonSubdirs []string) (string, error)

FindFileInDirectory searches for a file by name in a directory, checking common locations first and then recursively searching if not found. Returns the full path to the file or an error if not found.

Parameters:

  • baseDir: The directory to search in
  • filename: The exact filename to search for (e.g., "javaagent.jar", "libjprofilerti.so")
  • commonSubdirs: Optional subdirectories to check first (e.g., ["lib", "bin/linux-x64"])

Example: 

agentPath, err := FindFileInDirectory(installDir, "javaagent.jar", []string{"", "lib"})

func FindFileInDirectoryWithArchFilter 

func FindFileInDirectoryWithArchFilter(baseDir, filename string, commonSubdirs []string, archDirs []string) (string, error)

FindFileInDirectoryWithArchFilter searches for a file by name in a directory with optional architecture filtering. This is useful when archives contain multiple platform versions (e.g., linux-aarch64, linux-amd64, linux-x64) and you need to ensure the correct one.

Parameters:

  • baseDir: The directory to search in
  • filename: The exact filename to search for
  • commonSubdirs: Optional subdirectories to check first
  • archDirs: Optional list of valid parent directory names (e.g., ["linux-x64", "linux-amd64"]). If nil, any parent directory is accepted.

Example: 

agentPath, err := FindFileInDirectoryWithArchFilter(installDir, "libjprofilerti.so",
    []string{"bin/linux-x64", "bin/linux-amd64"}, []string{"linux-x64", "linux-amd64"})

func GetApplicationName 

func GetApplicationName(includeSpace bool) string

GetApplicationName returns the application name from VCAP_APPLICATION. If includeSpace is true, returns "space_name:application_name" format, falling back to just "application_name" if space is not available. Returns empty string if application name is not available.

func GetVCAPServices 

func GetVCAPServices() (common.VCAPServices, error)

GetVCAPServices is a convenience wrapper around common.GetVCAPServices

Types

type Agent 

type Agent struct {
	HeapDumpFolder string     `yaml:"heap_dump_folder"`
	CheckInterval  string     `yaml:"check_interval"`
	MaxFrequency   string     `yaml:"max_frequency"`
	LogLevel       string     `yaml:"log_level"`
	Thresholds     Thresholds `yaml:"thresholds"`
}

type AppDynamicsFramework 

type AppDynamicsFramework struct {
	// contains filtered or unexported fields
}

AppDynamicsFramework implements AppDynamics APM agent support

func NewAppDynamicsFramework 

func NewAppDynamicsFramework(ctx *common.Context) *AppDynamicsFramework

NewAppDynamicsFramework creates a new AppDynamics framework instance

func (*AppDynamicsFramework) DependencyIdentifier 

func (a *AppDynamicsFramework) DependencyIdentifier() string

func (*AppDynamicsFramework) Detect 

func (a *AppDynamicsFramework) Detect() (string, error)

Detect checks if AppDynamics should be included

func (*AppDynamicsFramework) Finalize 

func (a *AppDynamicsFramework) Finalize() error

Finalize configures AppDynamics agent for runtime

func (*AppDynamicsFramework) Supply 

func (a *AppDynamicsFramework) Supply() error

Supply installs the AppDynamics agent

type AspectJWeaverAgentFramework 

type AspectJWeaverAgentFramework struct {
	// contains filtered or unexported fields
}

AspectJWeaverAgentFramework represents the AspectJ Weaver Agent framework

func NewAspectJWeaverAgentFramework 

func NewAspectJWeaverAgentFramework(ctx *common.Context) *AspectJWeaverAgentFramework

NewAspectJWeaverAgentFramework creates a new AspectJ Weaver Agent framework instance

func (*AspectJWeaverAgentFramework) Detect 

func (a *AspectJWeaverAgentFramework) Detect() (string, error)

Detect determines if AspectJ Weaver JAR and configuration exist in the application

func (*AspectJWeaverAgentFramework) Finalize 

func (a *AspectJWeaverAgentFramework) Finalize() error

Finalize configures the AspectJ Weaver agent for runtime

func (*AspectJWeaverAgentFramework) Supply 

func (a *AspectJWeaverAgentFramework) Supply() error

Supply phase - nothing to install for AspectJ (app-provided JAR)

type AzureApplicationInsightsAgentFramework 

type AzureApplicationInsightsAgentFramework struct {
	// contains filtered or unexported fields
}

AzureApplicationInsightsAgentFramework represents the Azure Application Insights Java agent framework

func NewAzureApplicationInsightsAgentFramework 

func NewAzureApplicationInsightsAgentFramework(ctx *common.Context) *AzureApplicationInsightsAgentFramework

NewAzureApplicationInsightsAgentFramework creates a new Azure Application Insights agent framework instance

func (*AzureApplicationInsightsAgentFramework) DependencyIdentifier 

func (a *AzureApplicationInsightsAgentFramework) DependencyIdentifier() string

func (*AzureApplicationInsightsAgentFramework) Detect 

func (a *AzureApplicationInsightsAgentFramework) Detect() (string, error)

Detect checks if Azure Application Insights should be enabled

func (*AzureApplicationInsightsAgentFramework) Finalize 

func (a *AzureApplicationInsightsAgentFramework) Finalize() error

Finalize configures the Azure Application Insights agent

func (*AzureApplicationInsightsAgentFramework) Supply 

func (a *AzureApplicationInsightsAgentFramework) Supply() error

Supply downloads and installs the Azure Application Insights agent

type AzureCredentials 

type AzureCredentials struct {
	ConnectionString   string
	InstrumentationKey string
}

AzureCredentials holds Azure Application Insights credentials

type CfMetricsExporterFramework 

type CfMetricsExporterFramework struct {
	// contains filtered or unexported fields
}

func NewCfMetricsExporterFramework 

func NewCfMetricsExporterFramework(ctx *common.Context) *CfMetricsExporterFramework

func (*CfMetricsExporterFramework) Detect 

func (f *CfMetricsExporterFramework) Detect() (string, error)

func (*CfMetricsExporterFramework) Finalize 

func (f *CfMetricsExporterFramework) Finalize() error

func (*CfMetricsExporterFramework) Supply 

func (f *CfMetricsExporterFramework) Supply() error

type CheckmarxCredentials 

type CheckmarxCredentials struct {
	URL        string // Agent download URL
	ManagerURL string // Checkmarx manager URL
	APIKey     string // API key for authentication
}

CheckmarxCredentials holds Checkmarx IAST credentials

type CheckmarxIASTAgentFramework 

type CheckmarxIASTAgentFramework struct {
	// contains filtered or unexported fields
}

CheckmarxIASTAgentFramework represents the Checkmarx IAST agent framework

func NewCheckmarxIASTAgentFramework 

func NewCheckmarxIASTAgentFramework(ctx *common.Context) *CheckmarxIASTAgentFramework

NewCheckmarxIASTAgentFramework creates a new Checkmarx IAST agent framework instance

func (*CheckmarxIASTAgentFramework) Detect 

func (c *CheckmarxIASTAgentFramework) Detect() (string, error)

Detect checks if Checkmarx IAST agent should be enabled

func (*CheckmarxIASTAgentFramework) Finalize 

func (c *CheckmarxIASTAgentFramework) Finalize() error

Finalize configures the Checkmarx IAST agent

func (*CheckmarxIASTAgentFramework) Supply 

func (c *CheckmarxIASTAgentFramework) Supply() error

Supply downloads and installs the Checkmarx IAST agent

type CleanUp 

type CleanUp struct {
	MaxDumpCount int `yaml:"max_dump_count"`
}

type ClientCertificateMapperFramework 

type ClientCertificateMapperFramework struct {
	// contains filtered or unexported fields
}

ClientCertificateMapperFramework implements mTLS client certificate mapper support This framework provides automatic mapping of Cloud Foundry client certificates for mutual TLS (mTLS) authentication in Java applications

func NewClientCertificateMapperFramework 

func NewClientCertificateMapperFramework(ctx *common.Context) *ClientCertificateMapperFramework

NewClientCertificateMapperFramework creates a new client certificate mapper framework instance

func (*ClientCertificateMapperFramework) DependencyIdentifier 

func (c *ClientCertificateMapperFramework) DependencyIdentifier() string

func (*ClientCertificateMapperFramework) Detect 

func (c *ClientCertificateMapperFramework) Detect() (string, error)

Detect checks if client certificate mapper should be included Enabled by default to support mTLS scenarios, can be disabled via configuration

func (*ClientCertificateMapperFramework) Finalize 

func (c *ClientCertificateMapperFramework) Finalize() error

Finalize adds the client certificate mapper JAR to the application classpath

func (*ClientCertificateMapperFramework) Supply 

func (c *ClientCertificateMapperFramework) Supply() error

Supply installs the client certificate mapper JAR

type ContainerCustomizerFramework 

type ContainerCustomizerFramework struct {
	// contains filtered or unexported fields
}

ContainerCustomizerFramework implements Tomcat configuration customization for Spring Boot WAR applications

func NewContainerCustomizerFramework 

func NewContainerCustomizerFramework(ctx *common.Context) *ContainerCustomizerFramework

NewContainerCustomizerFramework creates a new Container Customizer framework instance

func (*ContainerCustomizerFramework) DependencyIdentifier 

func (c *ContainerCustomizerFramework) DependencyIdentifier() string

func (*ContainerCustomizerFramework) Detect 

func (c *ContainerCustomizerFramework) Detect() (string, error)

Detect checks if Container Customizer should be included Detects Spring Boot WAR files that need Tomcat customization

func (*ContainerCustomizerFramework) Finalize 

func (c *ContainerCustomizerFramework) Finalize() error

Finalize adds the Container Customizer JAR to the classpath The Container Customizer library provides hooks for external Tomcat configuration

func (*ContainerCustomizerFramework) Supply 

func (c *ContainerCustomizerFramework) Supply() error

Supply installs the Container Customizer library

type ContainerSecurityProviderFramework 

type ContainerSecurityProviderFramework struct {
	// contains filtered or unexported fields
}

ContainerSecurityProviderFramework implements container-based security provider support This framework provides CloudFoundryContainerProvider for Java security integration

func NewContainerSecurityProviderFramework 

func NewContainerSecurityProviderFramework(ctx *common.Context) *ContainerSecurityProviderFramework

NewContainerSecurityProviderFramework creates a new container security provider framework instance

func (*ContainerSecurityProviderFramework) DependencyIdentifier 

func (c *ContainerSecurityProviderFramework) DependencyIdentifier() string

func (*ContainerSecurityProviderFramework) Detect 

func (c *ContainerSecurityProviderFramework) Detect() (string, error)

Detect checks if container security provider should be included Enabled by default, can be disabled via configuration

func (*ContainerSecurityProviderFramework) Finalize 

func (c *ContainerSecurityProviderFramework) Finalize() error

Finalize configures the container security provider for runtime

func (*ContainerSecurityProviderFramework) Supply 

func (c *ContainerSecurityProviderFramework) Supply() error

Supply installs the container security provider JAR

type ContrastSecurityAgentFramework 

type ContrastSecurityAgentFramework struct {
	// contains filtered or unexported fields
}

ContrastSecurityAgentFramework represents the Contrast Security Agent framework

func NewContrastSecurityAgentFramework 

func NewContrastSecurityAgentFramework(ctx *common.Context) *ContrastSecurityAgentFramework

NewContrastSecurityAgentFramework creates a new instance of ContrastSecurityAgentFramework

func (*ContrastSecurityAgentFramework) DependencyIdentifier 

func (c *ContrastSecurityAgentFramework) DependencyIdentifier() string

func (*ContrastSecurityAgentFramework) Detect 

func (c *ContrastSecurityAgentFramework) Detect() (string, error)

Detect determines if Contrast Security service is bound

func (*ContrastSecurityAgentFramework) Finalize 

func (c *ContrastSecurityAgentFramework) Finalize() error

Finalize configures the Contrast Security agent for runtime

func (*ContrastSecurityAgentFramework) Supply 

func (c *ContrastSecurityAgentFramework) Supply() error

Supply downloads and installs the Contrast Security agent

type DatadogJavaagentFramework 

type DatadogJavaagentFramework struct {
	// contains filtered or unexported fields
}

DatadogJavaagentFramework represents the Datadog APM Java agent framework

func NewDatadogJavaagentFramework 

func NewDatadogJavaagentFramework(ctx *common.Context) *DatadogJavaagentFramework

NewDatadogJavaagentFramework creates a new Datadog Javaagent framework instance

func (*DatadogJavaagentFramework) DependencyIdentifier 

func (d *DatadogJavaagentFramework) DependencyIdentifier() string

func (*DatadogJavaagentFramework) Detect 

func (d *DatadogJavaagentFramework) Detect() (string, error)

Detect checks if Datadog APM should be enabled

func (*DatadogJavaagentFramework) Finalize 

func (d *DatadogJavaagentFramework) Finalize() error

Finalize configures the Datadog Java agent

func (*DatadogJavaagentFramework) Supply 

func (d *DatadogJavaagentFramework) Supply() error

Supply downloads and installs the Datadog Java agent

type DebugFramework 

type DebugFramework struct {
	// contains filtered or unexported fields
}

DebugFramework implements Java remote debugging support Enables JDWP (Java Debug Wire Protocol) for remote debugging

func NewDebugFramework 

func NewDebugFramework(ctx *common.Context) *DebugFramework

NewDebugFramework creates a new Debug framework instance

func (*DebugFramework) Detect 

func (d *DebugFramework) Detect() (string, error)

Detect checks if debugging should be enabled

func (*DebugFramework) Finalize 

func (d *DebugFramework) Finalize() error

Finalize adds debug options to JAVA_OPTS

func (*DebugFramework) Supply 

func (d *DebugFramework) Supply() error

Supply performs debug setup during supply phase

type DependencyIdentifierProvider 

type DependencyIdentifierProvider interface {
	DependencyIdentifier() string
}

Framework represents a cross-cutting concern (APM agents, security providers, etc.) DependencyIdentifierProvider optionally exposes a manifest dependency identifier for frameworks that install a specific dependency artifact.

type ElasticApmAgentFramework 

type ElasticApmAgentFramework struct {
	// contains filtered or unexported fields
}

ElasticApmAgentFramework represents the Elastic APM Java agent framework

func NewElasticApmAgentFramework 

func NewElasticApmAgentFramework(ctx *common.Context) *ElasticApmAgentFramework

NewElasticApmAgentFramework creates a new Elastic APM agent framework instance

func (*ElasticApmAgentFramework) DependencyIdentifier 

func (e *ElasticApmAgentFramework) DependencyIdentifier() string

func (*ElasticApmAgentFramework) Detect 

func (e *ElasticApmAgentFramework) Detect() (string, error)

Detect checks if Elastic APM service is bound

func (*ElasticApmAgentFramework) Finalize 

func (e *ElasticApmAgentFramework) Finalize() error

Finalize configures the Elastic APM agent

func (*ElasticApmAgentFramework) Supply 

func (e *ElasticApmAgentFramework) Supply() error

Supply downloads and installs the Elastic APM agent

type Framework 

type Framework interface {
	// Detect returns true if this framework should be included
	// Returns the framework name and version if detected
	Detect() (string, error)

	// Supply installs the framework
	Supply() error

	// Finalize performs final framework configuration
	Finalize() error
}

type GoogleProfilerCredentials 

type GoogleProfilerCredentials struct {
	ProjectID string
}

GoogleProfilerCredentials holds Google Cloud credentials

type GoogleStackdriverProfilerFramework 

type GoogleStackdriverProfilerFramework struct {
	// contains filtered or unexported fields
}

GoogleStackdriverProfilerFramework represents the Google Stackdriver Profiler framework

func NewGoogleStackdriverProfilerFramework 

func NewGoogleStackdriverProfilerFramework(ctx *common.Context) *GoogleStackdriverProfilerFramework

NewGoogleStackdriverProfilerFramework creates a new Google Stackdriver Profiler framework instance

func (*GoogleStackdriverProfilerFramework) DependencyIdentifier 

func (g *GoogleStackdriverProfilerFramework) DependencyIdentifier() string

func (*GoogleStackdriverProfilerFramework) Detect 

func (g *GoogleStackdriverProfilerFramework) Detect() (string, error)

Detect checks if Google Stackdriver Profiler should be enabled

func (*GoogleStackdriverProfilerFramework) Finalize 

func (g *GoogleStackdriverProfilerFramework) Finalize() error

Finalize configures the Google Stackdriver Profiler

func (*GoogleStackdriverProfilerFramework) Supply 

func (g *GoogleStackdriverProfilerFramework) Supply() error

Supply downloads and installs the Google Stackdriver Profiler

type IntroscopeAgentFramework 

type IntroscopeAgentFramework struct {
	// contains filtered or unexported fields
}

IntroscopeAgentFramework represents the CA APM Introscope agent framework

func NewIntroscopeAgentFramework 

func NewIntroscopeAgentFramework(ctx *common.Context) *IntroscopeAgentFramework

NewIntroscopeAgentFramework creates a new Introscope agent framework instance

func (*IntroscopeAgentFramework) DependencyIdentifier 

func (i *IntroscopeAgentFramework) DependencyIdentifier() string

func (*IntroscopeAgentFramework) Detect 

func (i *IntroscopeAgentFramework) Detect() (string, error)

Detect checks if Introscope agent should be enabled

func (*IntroscopeAgentFramework) Finalize 

func (i *IntroscopeAgentFramework) Finalize() error

Finalize configures the Introscope agent

func (*IntroscopeAgentFramework) Supply 

func (i *IntroscopeAgentFramework) Supply() error

Supply downloads and installs the Introscope agent

type IntroscopeCredentials 

type IntroscopeCredentials struct {
	AgentName string
	EMHost    string
	EMPort    string
}

IntroscopeCredentials holds Introscope agent credentials

type JProfilerProfilerFramework 

type JProfilerProfilerFramework struct {
	// contains filtered or unexported fields
}

JProfilerProfilerFramework represents the JProfiler profiler framework

func NewJProfilerProfilerFramework 

func NewJProfilerProfilerFramework(ctx *common.Context) *JProfilerProfilerFramework

NewJProfilerProfilerFramework creates a new JProfilerProfilerFramework instance

func (*JProfilerProfilerFramework) Detect 

func (f *JProfilerProfilerFramework) Detect() (string, error)

Detect returns the framework name if JProfiler is explicitly enabled

func (*JProfilerProfilerFramework) Finalize 

func (f *JProfilerProfilerFramework) Finalize() error

Finalize configures the JProfiler profiler runtime environment

func (*JProfilerProfilerFramework) Supply 

func (f *JProfilerProfilerFramework) Supply() error

Supply downloads and installs the JProfiler profiler

type JRebelAgentFramework 

type JRebelAgentFramework struct {
	// contains filtered or unexported fields
}

JRebelAgentFramework represents the JRebel Agent framework

func NewJRebelAgentFramework 

func NewJRebelAgentFramework(ctx *common.Context) *JRebelAgentFramework

NewJRebelAgentFramework creates a new instance of JRebelAgentFramework

func (*JRebelAgentFramework) DependencyIdentifier 

func (j *JRebelAgentFramework) DependencyIdentifier() string

func (*JRebelAgentFramework) Detect 

func (j *JRebelAgentFramework) Detect() (string, error)

Detect determines if JRebel configuration exists in the application

func (*JRebelAgentFramework) Finalize 

func (j *JRebelAgentFramework) Finalize() error

Finalize configures the JRebel agent for runtime

func (*JRebelAgentFramework) Supply 

func (j *JRebelAgentFramework) Supply() error

Supply downloads and installs the JRebel agent

type JacocoAgentFramework 

type JacocoAgentFramework struct {
	// contains filtered or unexported fields
}

JacocoAgentFramework implements JaCoCo code coverage agent support

func NewJacocoAgentFramework 

func NewJacocoAgentFramework(ctx *common.Context) *JacocoAgentFramework

NewJacocoAgentFramework creates a new JaCoCo agent framework instance

func (*JacocoAgentFramework) DependencyIdentifier 

func (j *JacocoAgentFramework) DependencyIdentifier() string

func (*JacocoAgentFramework) Detect 

func (j *JacocoAgentFramework) Detect() (string, error)

Detect checks if JaCoCo agent should be included

func (*JacocoAgentFramework) Finalize 

func (j *JacocoAgentFramework) Finalize() error

Finalize configures the JaCoCo agent for runtime

func (*JacocoAgentFramework) Supply 

func (j *JacocoAgentFramework) Supply() error

Supply installs the JaCoCo agent

type JavaCfEnvFramework 

type JavaCfEnvFramework struct {
	// contains filtered or unexported fields
}

JavaCfEnvFramework implements java-cfenv support for Cloud Foundry This is the modern replacement for Spring Auto-reconfiguration It provides auto-configuration for Spring Boot 3.x applications

func NewJavaCfEnvFramework 

func NewJavaCfEnvFramework(ctx *common.Context) *JavaCfEnvFramework

NewJavaCfEnvFramework creates a new java-cfenv framework instance

func (*JavaCfEnvFramework) DependencyIdentifier 

func (j *JavaCfEnvFramework) DependencyIdentifier() string

func (*JavaCfEnvFramework) Detect 

func (j *JavaCfEnvFramework) Detect() (string, error)

Detect checks if java-cfenv should be included

func (*JavaCfEnvFramework) Finalize 

func (j *JavaCfEnvFramework) Finalize() error

Finalize performs final java-cfenv configuration

func (*JavaCfEnvFramework) Supply 

func (j *JavaCfEnvFramework) Supply() error

Supply installs the java-cfenv JAR

type JavaMemoryAssistantFramework 

type JavaMemoryAssistantFramework struct {
	// contains filtered or unexported fields
}

JavaMemoryAssistantFramework implements Java Memory Assistant agent support This framework provides automatic heap dump generation based on memory usage thresholds

func NewJavaMemoryAssistantFramework 

func NewJavaMemoryAssistantFramework(ctx *common.Context) *JavaMemoryAssistantFramework

NewJavaMemoryAssistantFramework creates a new Java Memory Assistant framework instance

func (*JavaMemoryAssistantFramework) DependencyIdentifier 

func (j *JavaMemoryAssistantFramework) DependencyIdentifier() string

func (*JavaMemoryAssistantFramework) Detect 

func (j *JavaMemoryAssistantFramework) Detect() (string, error)

Detect checks if Java Memory Assistant should be included Must be explicitly enabled via configuration (disabled by default)

func (*JavaMemoryAssistantFramework) Finalize 

func (j *JavaMemoryAssistantFramework) Finalize() error

Finalize configures the Java Memory Assistant agent as a javaagent

func (*JavaMemoryAssistantFramework) Supply 

func (j *JavaMemoryAssistantFramework) Supply() error

Supply installs the Java Memory Assistant agent and cleanup utility

type JavaOptsConfig 

type JavaOptsConfig struct {
	FromEnvironment bool     `yaml:"from_environment"`
	JavaOpts        []string `yaml:"java_opts"`
}

JavaOptsConfig represents the java_opts.yml configuration

type JavaOptsFramework 

type JavaOptsFramework struct {
	// contains filtered or unexported fields
}

JavaOptsFramework implements custom JAVA_OPTS configuration

func NewJavaOptsFramework 

func NewJavaOptsFramework(ctx *common.Context) *JavaOptsFramework

NewJavaOptsFramework creates a new Java Opts framework instance

func (*JavaOptsFramework) Detect 

func (j *JavaOptsFramework) Detect() (string, error)

Detect returns a positive result if loadConfig() finds settings (universal framework for JAVA_OPTS configuration)

func (*JavaOptsFramework) Finalize 

func (j *JavaOptsFramework) Finalize() error

Finalize applies the JAVA_OPTS configuration

func (*JavaOptsFramework) Supply 

func (j *JavaOptsFramework) Supply() error

Supply does nothing (no dependencies to install)

type JmxFramework 

type JmxFramework struct {
	// contains filtered or unexported fields
}

JmxFramework implements JMX (Java Management Extensions) support Enables remote JMX monitoring and management

func NewJmxFramework 

func NewJmxFramework(ctx *common.Context) *JmxFramework

NewJmxFramework creates a new JMX framework instance

func (*JmxFramework) Detect 

func (j *JmxFramework) Detect() (string, error)

Detect checks if JMX should be enabled

func (*JmxFramework) Finalize 

func (j *JmxFramework) Finalize() error

Finalize adds JMX options to JAVA_OPTS via profile.d script

func (*JmxFramework) Supply 

func (j *JmxFramework) Supply() error

Supply performs JMX setup during supply phase

type LunaSecurityProviderFramework 

type LunaSecurityProviderFramework struct {
	// contains filtered or unexported fields
}

LunaSecurityProviderFramework implements Safenet Luna HSM Java Security Provider support This framework enables zero-touch integration with Gemalto Luna HSM for cryptographic operations

func NewLunaSecurityProviderFramework 

func NewLunaSecurityProviderFramework(ctx *common.Context) *LunaSecurityProviderFramework

NewLunaSecurityProviderFramework creates a new Luna security provider framework instance

func (*LunaSecurityProviderFramework) DependencyIdentifier 

func (l *LunaSecurityProviderFramework) DependencyIdentifier() string

func (*LunaSecurityProviderFramework) Detect 

func (l *LunaSecurityProviderFramework) Detect() (string, error)

Detect checks if Luna security provider should be included Requires Luna service binding with client credentials

func (*LunaSecurityProviderFramework) Finalize 

func (l *LunaSecurityProviderFramework) Finalize() error

Finalize configures the Luna security provider for runtime

func (*LunaSecurityProviderFramework) Supply 

func (l *LunaSecurityProviderFramework) Supply() error

Supply installs the Luna security provider tarball and credentials

type MariaDBJDBCFramework 

type MariaDBJDBCFramework struct {
	// contains filtered or unexported fields
}

MariaDBJDBCFramework represents the MariaDB JDBC framework

func NewMariaDBJDBCFramework 

func NewMariaDBJDBCFramework(ctx *common.Context) *MariaDBJDBCFramework

NewMariaDBJDBCFramework creates a new MariaDB JDBC framework instance

func (*MariaDBJDBCFramework) DependencyIdentifier 

func (f *MariaDBJDBCFramework) DependencyIdentifier() string

func (*MariaDBJDBCFramework) Detect 

func (f *MariaDBJDBCFramework) Detect() (string, error)

Detect checks if MariaDB/MySQL JDBC should be installed

func (*MariaDBJDBCFramework) Finalize 

func (f *MariaDBJDBCFramework) Finalize() error

Finalize adds the MariaDB JDBC driver to the classpath

func (*MariaDBJDBCFramework) Supply 

func (f *MariaDBJDBCFramework) Supply() error

Supply downloads and installs the MariaDB JDBC driver

type MetricWriterFramework 

type MetricWriterFramework struct {
	// contains filtered or unexported fields
}

MetricWriterFramework implements Micrometer metrics enhancement This framework adds CloudFoundry-specific tags to Micrometer metrics

func NewMetricWriterFramework 

func NewMetricWriterFramework(ctx *common.Context) *MetricWriterFramework

NewMetricWriterFramework creates a new Metric Writer framework instance

func (*MetricWriterFramework) DependencyIdentifier 

func (m *MetricWriterFramework) DependencyIdentifier() string

func (*MetricWriterFramework) Detect 

func (m *MetricWriterFramework) Detect() (string, error)

Detect checks if Metric Writer should be included Detects Micrometer presence and checks if enabled

func (*MetricWriterFramework) Finalize 

func (m *MetricWriterFramework) Finalize() error

Finalize adds the Metric Writer JAR to the classpath and configures CF tags

func (*MetricWriterFramework) Supply 

func (m *MetricWriterFramework) Supply() error

Supply installs the Metric Writer library

type NewRelicFramework 

type NewRelicFramework struct {
	// contains filtered or unexported fields
}

NewRelicFramework implements New Relic APM agent support

func NewNewRelicFramework 

func NewNewRelicFramework(ctx *common.Context) *NewRelicFramework

NewNewRelicFramework creates a new New Relic framework instance

func (*NewRelicFramework) DependencyIdentifier 

func (n *NewRelicFramework) DependencyIdentifier() string

func (*NewRelicFramework) Detect 

func (n *NewRelicFramework) Detect() (string, error)

Detect checks if New Relic should be included

func (*NewRelicFramework) Finalize 

func (n *NewRelicFramework) Finalize() error

Finalize performs final New Relic configuration

func (*NewRelicFramework) Supply 

func (n *NewRelicFramework) Supply() error

Supply installs the New Relic agent

type OpenTelemetryJavaagentFramework 

type OpenTelemetryJavaagentFramework struct {
	// contains filtered or unexported fields
}

OpenTelemetryJavaagentFramework implements OpenTelemetry instrumentation support

func NewOpenTelemetryJavaagentFramework 

func NewOpenTelemetryJavaagentFramework(ctx *common.Context) *OpenTelemetryJavaagentFramework

NewOpenTelemetryJavaagentFramework creates a new OpenTelemetry Javaagent framework instance

func (*OpenTelemetryJavaagentFramework) DependencyIdentifier 

func (o *OpenTelemetryJavaagentFramework) DependencyIdentifier() string

func (*OpenTelemetryJavaagentFramework) Detect 

func (o *OpenTelemetryJavaagentFramework) Detect() (string, error)

Detect checks if OpenTelemetry should be included

func (*OpenTelemetryJavaagentFramework) Finalize 

func (o *OpenTelemetryJavaagentFramework) Finalize() error

Finalize performs final OpenTelemetry configuration

func (*OpenTelemetryJavaagentFramework) Supply 

func (o *OpenTelemetryJavaagentFramework) Supply() error

Supply installs the OpenTelemetry Javaagent

type PostgresqlJdbcFramework 

type PostgresqlJdbcFramework struct {
	// contains filtered or unexported fields
}

PostgresqlJdbcFramework implements PostgreSQL JDBC driver support Automatically installs PostgreSQL JDBC driver if a PostgreSQL service is bound

func NewPostgresqlJdbcFramework 

func NewPostgresqlJdbcFramework(ctx *common.Context) *PostgresqlJdbcFramework

NewPostgresqlJdbcFramework creates a new PostgreSQL JDBC framework instance

func (*PostgresqlJdbcFramework) DependencyIdentifier 

func (p *PostgresqlJdbcFramework) DependencyIdentifier() string

func (*PostgresqlJdbcFramework) Detect 

func (p *PostgresqlJdbcFramework) Detect() (string, error)

Detect checks if PostgreSQL JDBC driver should be installed

func (*PostgresqlJdbcFramework) Finalize 

func (p *PostgresqlJdbcFramework) Finalize() error

Finalize adds PostgreSQL JDBC driver to classpath

func (*PostgresqlJdbcFramework) Supply 

func (p *PostgresqlJdbcFramework) Supply() error

Supply installs the PostgreSQL JDBC driver

type ProtectAppSecurityProviderFramework 

type ProtectAppSecurityProviderFramework struct {
	// contains filtered or unexported fields
}

ProtectAppSecurityProviderFramework implements Safenet ProtectApp security provider support This framework provides integration with Safenet ProtectApp (now Gemalto/Thales) for key management

func NewProtectAppSecurityProviderFramework 

func NewProtectAppSecurityProviderFramework(ctx *common.Context) *ProtectAppSecurityProviderFramework

NewProtectAppSecurityProviderFramework creates a new ProtectApp security provider framework instance

func (*ProtectAppSecurityProviderFramework) DependencyIdentifier 

func (p *ProtectAppSecurityProviderFramework) DependencyIdentifier() string

func (*ProtectAppSecurityProviderFramework) Detect 

func (p *ProtectAppSecurityProviderFramework) Detect() (string, error)

Detect checks if ProtectApp security provider should be included Detects when a service with "protectapp" in its name/label/tag is bound

func (*ProtectAppSecurityProviderFramework) Finalize 

func (p *ProtectAppSecurityProviderFramework) Finalize() error

Finalize configures the ProtectApp security provider for runtime

func (*ProtectAppSecurityProviderFramework) Supply 

func (p *ProtectAppSecurityProviderFramework) Supply() error

Supply installs the ProtectApp security provider JAR

type Registry 

type Registry struct {
	// contains filtered or unexported fields
}

Registry manages available frameworks

func NewRegistry 

func NewRegistry(ctx *common.Context) *Registry

NewRegistry creates a new framework registry

func (*Registry) DetectAll 

func (r *Registry) DetectAll() ([]Framework, []string, error)

DetectAll returns all frameworks that should be included

func (*Registry) Register 

func (r *Registry) Register(f Framework)

Register adds a framework to the registry

func (*Registry) RegisterStandardFrameworks 

func (r *Registry) RegisterStandardFrameworks()

RegisterStandardFrameworks registers all standard frameworks in the correct priority order. This ensures Supply and Finalize phases use the same detection order. IMPORTANT: The order matters! Frameworks are checked in registration order.

type RiverbedAppInternalsAgentFramework 

type RiverbedAppInternalsAgentFramework struct {
	// contains filtered or unexported fields
}

RiverbedAppInternalsAgentFramework represents the Riverbed AppInternals agent framework

func NewRiverbedAppInternalsAgentFramework 

func NewRiverbedAppInternalsAgentFramework(ctx *common.Context) *RiverbedAppInternalsAgentFramework

NewRiverbedAppInternalsAgentFramework creates a new Riverbed AppInternals agent framework instance

func (*RiverbedAppInternalsAgentFramework) DependencyIdentifier 

func (r *RiverbedAppInternalsAgentFramework) DependencyIdentifier() string

func (*RiverbedAppInternalsAgentFramework) Detect 

func (r *RiverbedAppInternalsAgentFramework) Detect() (string, error)

Detect checks if Riverbed AppInternals agent should be enabled

func (*RiverbedAppInternalsAgentFramework) Finalize 

func (r *RiverbedAppInternalsAgentFramework) Finalize() error

Finalize configures the Riverbed AppInternals agent

func (*RiverbedAppInternalsAgentFramework) Supply 

func (r *RiverbedAppInternalsAgentFramework) Supply() error

Supply downloads and installs the Riverbed AppInternals agent

type RiverbedCredentials 

type RiverbedCredentials struct {
	Moniker        string
	AnalysisServer string
}

RiverbedCredentials holds Riverbed AppInternals credentials

type SealightsAgentFramework 

type SealightsAgentFramework struct {
	// contains filtered or unexported fields
}

SealightsAgentFramework represents the Sealights agent framework

func NewSealightsAgentFramework 

func NewSealightsAgentFramework(ctx *common.Context) *SealightsAgentFramework

NewSealightsAgentFramework creates a new SealightsAgentFramework instance

func (*SealightsAgentFramework) Detect 

func (f *SealightsAgentFramework) Detect() (string, error)

Detect returns the framework name if a Sealights service is bound

func (*SealightsAgentFramework) Finalize 

func (f *SealightsAgentFramework) Finalize() error

Finalize configures the Sealights agent runtime environment

func (*SealightsAgentFramework) Supply 

func (f *SealightsAgentFramework) Supply() error

Supply downloads and installs the Sealights agent

type SeekerSecurityProviderFramework 

type SeekerSecurityProviderFramework struct {
	// contains filtered or unexported fields
}

SeekerSecurityProviderFramework implements Synopsys Seeker IAST agent support This framework provides integration with Synopsys Seeker for interactive application security testing

func NewSeekerSecurityProviderFramework 

func NewSeekerSecurityProviderFramework(ctx *common.Context) *SeekerSecurityProviderFramework

NewSeekerSecurityProviderFramework creates a new Seeker security provider framework instance

func (*SeekerSecurityProviderFramework) Detect 

func (s *SeekerSecurityProviderFramework) Detect() (string, error)

Detect checks if Seeker security provider should be included Detects when a service with "seeker" in its name/label/tag is bound

func (*SeekerSecurityProviderFramework) Finalize 

func (s *SeekerSecurityProviderFramework) Finalize() error

Finalize configures the Seeker agent for runtime

func (*SeekerSecurityProviderFramework) Supply 

func (s *SeekerSecurityProviderFramework) Supply() error

Supply installs the Seeker agent by downloading from Seeker server

type SkyWalkingAgentFramework 

type SkyWalkingAgentFramework struct {
	// contains filtered or unexported fields
}

SkyWalkingAgentFramework represents the Apache SkyWalking agent framework

func NewSkyWalkingAgentFramework 

func NewSkyWalkingAgentFramework(ctx *common.Context) *SkyWalkingAgentFramework

NewSkyWalkingAgentFramework creates a new SkyWalking agent framework instance

func (*SkyWalkingAgentFramework) DependencyIdentifier 

func (s *SkyWalkingAgentFramework) DependencyIdentifier() string

func (*SkyWalkingAgentFramework) Detect 

func (s *SkyWalkingAgentFramework) Detect() (string, error)

Detect checks if SkyWalking agent should be enabled

func (*SkyWalkingAgentFramework) Finalize 

func (s *SkyWalkingAgentFramework) Finalize() error

Finalize configures the SkyWalking agent

func (*SkyWalkingAgentFramework) Supply 

func (s *SkyWalkingAgentFramework) Supply() error

Supply downloads and installs the SkyWalking agent

type SkyWalkingCredentials 

type SkyWalkingCredentials struct {
	CollectorBackendServices string
}

SkyWalkingCredentials holds SkyWalking agent credentials

type SplunkCredentials 

type SplunkCredentials struct {
	OTLPEndpoint string
	AccessToken  string
	Realm        string
}

SplunkCredentials holds Splunk OTEL credentials

type SplunkOtelJavaAgentFramework 

type SplunkOtelJavaAgentFramework struct {
	// contains filtered or unexported fields
}

SplunkOtelJavaAgentFramework represents the Splunk Distribution of OpenTelemetry Java agent framework

func NewSplunkOtelJavaAgentFramework 

func NewSplunkOtelJavaAgentFramework(ctx *common.Context) *SplunkOtelJavaAgentFramework

NewSplunkOtelJavaAgentFramework creates a new Splunk OTEL Java agent framework instance

func (*SplunkOtelJavaAgentFramework) DependencyIdentifier 

func (s *SplunkOtelJavaAgentFramework) DependencyIdentifier() string

func (*SplunkOtelJavaAgentFramework) Detect 

func (s *SplunkOtelJavaAgentFramework) Detect() (string, error)

Detect checks if Splunk OTEL Java agent should be enabled

func (*SplunkOtelJavaAgentFramework) Finalize 

func (s *SplunkOtelJavaAgentFramework) Finalize() error

Finalize configures the Splunk OTEL Java agent

func (*SplunkOtelJavaAgentFramework) Supply 

func (s *SplunkOtelJavaAgentFramework) Supply() error

Supply downloads and installs the Splunk OTEL Java agent

type SpringAutoReconfigurationFramework 

type SpringAutoReconfigurationFramework struct {
	// contains filtered or unexported fields
}

SpringAutoReconfigurationFramework implements Spring Auto-reconfiguration support for Cloud Foundry This framework automatically reconfigures Spring applications to use Cloud Foundry services DEPRECATED: This framework is disabled by default as of Dec 2025. Please migrate to java-cfenv. Can be re-enabled with: JBP_CONFIG_SPRING_AUTO_RECONFIGURATION='{enabled: true}'

func NewSpringAutoReconfigurationFramework 

func NewSpringAutoReconfigurationFramework(ctx *common.Context) *SpringAutoReconfigurationFramework

NewSpringAutoReconfigurationFramework creates a new Spring Auto-reconfiguration framework instance

func (*SpringAutoReconfigurationFramework) DependencyIdentifier 

func (s *SpringAutoReconfigurationFramework) DependencyIdentifier() string

func (*SpringAutoReconfigurationFramework) Detect 

func (s *SpringAutoReconfigurationFramework) Detect() (string, error)

Detect checks if Spring Auto-reconfiguration should be included

func (*SpringAutoReconfigurationFramework) Finalize 

func (s *SpringAutoReconfigurationFramework) Finalize() error

Finalize performs final Spring Auto-reconfiguration configuration

func (*SpringAutoReconfigurationFramework) Supply 

func (s *SpringAutoReconfigurationFramework) Supply() error

Supply installs the Spring Auto-reconfiguration JAR

type Thresholds 

type Thresholds struct {
	Heap                     string `yaml:"heap"`
	CodeCache                string `yaml:"code_cache"`
	Metaspace                string `yaml:"metaspace"`
	PermGen                  string `yaml:"perm_gen"`
	CompressedClass          string `yaml:"compressed_class"`
	Eden                     string `yaml:"eden"`
	Survivor                 string `yaml:"survivor"`
	OldGen                   string `yaml:"old_gen"`
	TenuredGen               string `yaml:"tenured_gen"`
	CodeHeapNonNMethods      string `yaml:"code_heap.non_nmethods"`
	CodeHeapNonProfiled      string `yaml:"code_heap.non_profiled_nmethods"`
	CodeHeapProfiledNMethods string `yaml:"code_heap.profiled_nmethods"`
}

type VCAPService 

type VCAPService = common.VCAPService

type VCAPServices 

type VCAPServices = common.VCAPServices

Type aliases for backward compatibility All VCAP types and functions are now in common package

type YourKitProfilerFramework 

type YourKitProfilerFramework struct {
	// contains filtered or unexported fields
}

YourKitProfilerFramework represents the YourKit profiler framework

func NewYourKitProfilerFramework 

func NewYourKitProfilerFramework(ctx *common.Context) *YourKitProfilerFramework

NewYourKitProfilerFramework creates a new YourKitProfilerFramework instance

func (*YourKitProfilerFramework) DependencyIdentifier 

func (f *YourKitProfilerFramework) DependencyIdentifier() string

func (*YourKitProfilerFramework) Detect 

func (f *YourKitProfilerFramework) Detect() (string, error)

Detect returns the framework name if YourKit is explicitly enabled

func (*YourKitProfilerFramework) Finalize 

func (f *YourKitProfilerFramework) Finalize() error

Finalize configures the YourKit profiler runtime environment

func (*YourKitProfilerFramework) Supply 

func (f *YourKitProfilerFramework) Supply() error

Supply downloads and installs the YourKit profiler native library

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.