Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add option to print JVM command in integration logs #1496

Merged
merged 1 commit into from
Jun 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions deploy/traits.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,10 @@ traits:
- name: options
type: string
description: A comma-separated list of JVM options
- name: print-command
type: bool
description: Prints the command used the start the JVM in the container logs (default
`true`)
- name: knative-service
platform: false
profiles:
Expand Down
4 changes: 4 additions & 0 deletions docs/modules/traits/pages/jvm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ The following configuration options are available:
| string
| A comma-separated list of JVM options

| jvm.print-command
| bool
| Prints the command used the start the JVM in the container logs (default `true`)

|===

// End of autogenerated code - DO NOT EDIT! (configuration)
108 changes: 62 additions & 46 deletions pkg/trait/jvm.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (
"sort"
"strings"

inf "gopkg.in/inf.v0"
"gopkg.in/inf.v0"

"github.com/pkg/errors"
"github.com/scylladb/go-set/strset"
Expand All @@ -48,13 +48,16 @@ type jvmTrait struct {
DebugAddress string `property:"debug-address"`
// A comma-separated list of JVM options
Options *string `property:"options"`
// Prints the command used the start the JVM in the container logs (default `true`)
PrintCommand bool `property:"print-command"`
}

func newJvmTrait() Trait {
return &jvmTrait{
BaseTrait: NewBaseTrait("jvm", 2000),
// To be defaulted to "*:5005" when upgrading the default base image to JDK9+
DebugAddress: "5005",
PrintCommand: true,
}
}

Expand Down Expand Up @@ -106,59 +109,72 @@ func (t *jvmTrait) Apply(e *Environment) error {
}

container := e.getIntegrationContainer()
if container != nil {
// Set the container command and working directory
container.Command = []string{"java"}
container.WorkingDir = "/deployments"

// Remote debugging
if t.Debug {
suspend := "n"
if t.DebugSuspend {
suspend = "y"
}
container.Args = append(container.Args,
fmt.Sprintf("-agentlib:jdwp=transport=dt_socket,server=y,suspend=%s,address=%s",
suspend, t.DebugAddress))
}
if container == nil {
return nil
}

hasHeapSizeOption := false
// Add JVM options
if t.Options != nil {
hasHeapSizeOption = strings.Contains(*t.Options, "-Xmx") ||
strings.Contains(*t.Options, "-XX:MaxHeapSize") ||
strings.Contains(*t.Options, "-XX:MinRAMPercentage") ||
strings.Contains(*t.Options, "-XX:MaxRAMPercentage")
// Build the container command
var args []string

container.Args = append(container.Args, strings.Split(*t.Options, ",")...)
// Remote debugging
if t.Debug {
suspend := "n"
if t.DebugSuspend {
suspend = "y"
}
args = append(args,
fmt.Sprintf("-agentlib:jdwp=transport=dt_socket,server=y,suspend=%s,address=%s",
suspend, t.DebugAddress))
}

// Tune JVM maximum heap size based on the container memory limit, if any.
// This is configured off-container, thus is limited to explicit user configuration.
// We may want to inject a wrapper script into the container image, so that it can
// be performed in-container, based on CGroups memory resource control files.
if memory, hasLimit := container.Resources.Limits[corev1.ResourceMemory]; !hasHeapSizeOption && hasLimit {
// Simple heuristic that caps the maximum heap size to 50% of the memory limit
percentage := int64(50)
// Unless the memory limit is lower than 300M, in which case we leave more room for the non-heap memory
if resource.NewScaledQuantity(300, 6).Cmp(memory) > 0 {
percentage = 25
}
memory.AsDec().Mul(memory.AsDec(), inf.NewDec(percentage, 2))
container.Args = append(container.Args, fmt.Sprintf("-Xmx%dM", memory.ScaledValue(resource.Mega)))
}
hasHeapSizeOption := false
// Add JVM options
if t.Options != nil {
hasHeapSizeOption = strings.Contains(*t.Options, "-Xmx") ||
strings.Contains(*t.Options, "-XX:MaxHeapSize") ||
strings.Contains(*t.Options, "-XX:MinRAMPercentage") ||
strings.Contains(*t.Options, "-XX:MaxRAMPercentage")

// Add mounted resources to the class path
for _, m := range container.VolumeMounts {
classpath.Add(m.MountPath)
args = append(args, strings.Split(*t.Options, ",")...)
}

// Tune JVM maximum heap size based on the container memory limit, if any.
// This is configured off-container, thus is limited to explicit user configuration.
// We may want to inject a wrapper script into the container image, so that it can
// be performed in-container, based on CGroups memory resource control files.
if memory, hasLimit := container.Resources.Limits[corev1.ResourceMemory]; !hasHeapSizeOption && hasLimit {
// Simple heuristic that caps the maximum heap size to 50% of the memory limit
percentage := int64(50)
// Unless the memory limit is lower than 300M, in which case we leave more room for the non-heap memory
if resource.NewScaledQuantity(300, 6).Cmp(memory) > 0 {
percentage = 25
}
items := classpath.List()
// Keep class path sorted so that it's consistent over reconciliation cycles
sort.Strings(items)
memory.AsDec().Mul(memory.AsDec(), inf.NewDec(percentage, 2))
args = append(args, fmt.Sprintf("-Xmx%dM", memory.ScaledValue(resource.Mega)))
}

container.Args = append(container.Args, "-cp", strings.Join(items, ":"))
container.Args = append(container.Args, e.CamelCatalog.Runtime.ApplicationClass)
// Add mounted resources to the class path
for _, m := range container.VolumeMounts {
classpath.Add(m.MountPath)
}
items := classpath.List()
// Keep class path sorted so that it's consistent over reconciliation cycles
sort.Strings(items)

args = append(args, "-cp", strings.Join(items, ":"))
args = append(args, e.CamelCatalog.Runtime.ApplicationClass)

if t.PrintCommand {
args = append([]string{"java"}, args...)
container.Command = []string{"/bin/sh", "-c"}
cmd := strings.Join(args, " ")
container.Args = []string{"echo " + cmd + " && " + cmd}
} else {
container.Command = []string{"java"}
container.Args = args
}

container.WorkingDir = "/deployments"

return nil
}
Expand Down
1 change: 1 addition & 0 deletions pkg/trait/jvm_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,7 @@ func createJvmTestWithKitType(kitType string) (*jvmTrait, *Environment) {
trait := newJvmTrait().(*jvmTrait)
enabled := true
trait.Enabled = &enabled
trait.PrintCommand = false
trait.Ctx = context.TODO()
trait.Client = client

Expand Down