elastic-apm 3.4.0 → 3.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. checksums.yaml +4 -4
  2. data/.ci/.jenkins_exclude.yml +39 -20
  3. data/.ci/.jenkins_framework.yml +2 -2
  4. data/.ci/Jenkinsfile +286 -170
  5. data/.ci/docker/jruby/11-jdk/Dockerfile +40 -0
  6. data/.ci/docker/jruby/12-jdk/Dockerfile +40 -0
  7. data/.ci/docker/jruby/13-jdk/Dockerfile +40 -0
  8. data/.ci/docker/jruby/7-jdk/Dockerfile +40 -0
  9. data/.ci/docker/jruby/8-jdk/Dockerfile +40 -0
  10. data/.ci/docker/jruby/README.md +31 -0
  11. data/.ci/docker/jruby/run.sh +73 -0
  12. data/.ci/docker/jruby/test.sh +13 -0
  13. data/.ci/jobs/defaults.yml +1 -1
  14. data/.ci/packer_cache.sh +16 -0
  15. data/.github/ISSUE_TEMPLATE/Bug_report.md +13 -11
  16. data/.github/ISSUE_TEMPLATE/Feature_request.md +8 -8
  17. data/.github/PULL_REQUEST_TEMPLATE.md +51 -5
  18. data/.gitignore +5 -0
  19. data/.rspec +0 -1
  20. data/.rubocop.yml +13 -1
  21. data/CHANGELOG.asciidoc +94 -1
  22. data/CONTRIBUTING.md +6 -48
  23. data/Gemfile +34 -9
  24. data/README.md +62 -13
  25. data/Rakefile +37 -5
  26. data/bin/run-tests +4 -1
  27. data/docker-compose.yml +7 -0
  28. data/docs/api.asciidoc +15 -3
  29. data/docs/configuration.asciidoc +164 -32
  30. data/docs/debugging.asciidoc +14 -0
  31. data/docs/getting-started-rails.asciidoc +2 -0
  32. data/docs/graphql.asciidoc +23 -0
  33. data/docs/images/dynamic-config.svg +1 -0
  34. data/docs/index.asciidoc +6 -1
  35. data/docs/introduction.asciidoc +2 -1
  36. data/docs/performance-tuning.asciidoc +106 -0
  37. data/docs/set-up.asciidoc +5 -2
  38. data/docs/supported-technologies.asciidoc +68 -1
  39. data/docs/upgrading.asciidoc +45 -0
  40. data/elastic-apm.gemspec +17 -0
  41. data/lib/elastic-apm.rb +17 -0
  42. data/lib/elastic_apm.rb +29 -0
  43. data/lib/elastic_apm/agent.rb +49 -2
  44. data/lib/elastic_apm/central_config.rb +27 -8
  45. data/lib/elastic_apm/central_config/cache_control.rb +17 -0
  46. data/lib/elastic_apm/child_durations.rb +17 -0
  47. data/lib/elastic_apm/config.rb +82 -7
  48. data/lib/elastic_apm/config/bytes.rb +17 -0
  49. data/lib/elastic_apm/config/duration.rb +17 -0
  50. data/lib/elastic_apm/config/options.rb +18 -1
  51. data/lib/elastic_apm/config/regexp_list.rb +17 -0
  52. data/lib/elastic_apm/config/wildcard_pattern_list.rb +20 -1
  53. data/lib/elastic_apm/context.rb +17 -0
  54. data/lib/elastic_apm/context/request.rb +17 -0
  55. data/lib/elastic_apm/context/request/socket.rb +17 -0
  56. data/lib/elastic_apm/context/request/url.rb +17 -0
  57. data/lib/elastic_apm/context/response.rb +18 -1
  58. data/lib/elastic_apm/context/user.rb +17 -0
  59. data/lib/elastic_apm/context_builder.rb +17 -0
  60. data/lib/elastic_apm/deprecations.rb +17 -0
  61. data/lib/elastic_apm/error.rb +17 -0
  62. data/lib/elastic_apm/error/exception.rb +17 -0
  63. data/lib/elastic_apm/error/log.rb +17 -0
  64. data/lib/elastic_apm/error_builder.rb +17 -0
  65. data/lib/elastic_apm/grape.rb +17 -0
  66. data/lib/elastic_apm/graphql.rb +91 -0
  67. data/lib/elastic_apm/grpc.rb +99 -0
  68. data/lib/elastic_apm/instrumenter.rb +29 -4
  69. data/lib/elastic_apm/internal_error.rb +17 -0
  70. data/lib/elastic_apm/logging.rb +17 -0
  71. data/lib/elastic_apm/metadata.rb +17 -0
  72. data/lib/elastic_apm/metadata/process_info.rb +17 -0
  73. data/lib/elastic_apm/metadata/service_info.rb +22 -2
  74. data/lib/elastic_apm/metadata/system_info.rb +17 -0
  75. data/lib/elastic_apm/metadata/system_info/container_info.rb +17 -0
  76. data/lib/elastic_apm/metrics.rb +33 -1
  77. data/lib/elastic_apm/metrics/breakdown_set.rb +17 -0
  78. data/lib/elastic_apm/metrics/cpu_mem_set.rb +17 -0
  79. data/lib/elastic_apm/metrics/metric.rb +23 -4
  80. data/lib/elastic_apm/metrics/set.rb +17 -0
  81. data/lib/elastic_apm/metrics/span_scoped_set.rb +17 -0
  82. data/lib/elastic_apm/metrics/transaction_set.rb +17 -0
  83. data/lib/elastic_apm/metrics/vm_set.rb +17 -0
  84. data/lib/elastic_apm/metricset.rb +17 -0
  85. data/lib/elastic_apm/middleware.rb +20 -4
  86. data/lib/elastic_apm/naively_hashable.rb +17 -0
  87. data/lib/elastic_apm/normalizers.rb +17 -0
  88. data/lib/elastic_apm/normalizers/grape.rb +17 -0
  89. data/lib/elastic_apm/normalizers/grape/endpoint_run.rb +18 -1
  90. data/lib/elastic_apm/normalizers/rails.rb +17 -0
  91. data/lib/elastic_apm/normalizers/rails/action_controller.rb +17 -0
  92. data/lib/elastic_apm/normalizers/rails/action_mailer.rb +17 -0
  93. data/lib/elastic_apm/normalizers/rails/action_view.rb +17 -0
  94. data/lib/elastic_apm/normalizers/rails/active_record.rb +17 -0
  95. data/lib/elastic_apm/opentracing.rb +66 -24
  96. data/lib/elastic_apm/rails.rb +17 -0
  97. data/lib/elastic_apm/railtie.rb +17 -0
  98. data/lib/elastic_apm/resque.rb +29 -0
  99. data/lib/elastic_apm/sinatra.rb +17 -0
  100. data/lib/elastic_apm/span.rb +17 -0
  101. data/lib/elastic_apm/span/context.rb +17 -0
  102. data/lib/elastic_apm/span/context/db.rb +26 -2
  103. data/lib/elastic_apm/span/context/destination.rb +37 -4
  104. data/lib/elastic_apm/span/context/http.rb +17 -0
  105. data/lib/elastic_apm/span_helpers.rb +17 -0
  106. data/lib/elastic_apm/spies.rb +33 -14
  107. data/lib/elastic_apm/spies/action_dispatch.rb +17 -0
  108. data/lib/elastic_apm/spies/delayed_job.rb +17 -0
  109. data/lib/elastic_apm/spies/dynamo_db.rb +58 -0
  110. data/lib/elastic_apm/spies/elasticsearch.rb +37 -2
  111. data/lib/elastic_apm/spies/faraday.rb +18 -1
  112. data/lib/elastic_apm/spies/http.rb +19 -1
  113. data/lib/elastic_apm/spies/json.rb +17 -0
  114. data/lib/elastic_apm/spies/mongo.rb +18 -1
  115. data/lib/elastic_apm/spies/net_http.rb +25 -3
  116. data/lib/elastic_apm/spies/rake.rb +17 -0
  117. data/lib/elastic_apm/spies/redis.rb +17 -0
  118. data/lib/elastic_apm/spies/resque.rb +53 -0
  119. data/lib/elastic_apm/spies/sequel.rb +31 -4
  120. data/lib/elastic_apm/spies/shoryuken.rb +17 -0
  121. data/lib/elastic_apm/spies/sidekiq.rb +17 -0
  122. data/lib/elastic_apm/spies/sinatra.rb +17 -0
  123. data/lib/elastic_apm/spies/sneakers.rb +17 -0
  124. data/lib/elastic_apm/spies/sucker_punch.rb +54 -0
  125. data/lib/elastic_apm/spies/tilt.rb +17 -0
  126. data/lib/elastic_apm/sql.rb +21 -4
  127. data/lib/elastic_apm/sql/signature.rb +17 -0
  128. data/lib/elastic_apm/sql/tokenizer.rb +17 -0
  129. data/lib/elastic_apm/sql/tokens.rb +17 -0
  130. data/lib/elastic_apm/sql_summarizer.rb +17 -0
  131. data/lib/elastic_apm/stacktrace.rb +17 -0
  132. data/lib/elastic_apm/stacktrace/frame.rb +17 -0
  133. data/lib/elastic_apm/stacktrace_builder.rb +23 -1
  134. data/lib/elastic_apm/subscriber.rb +17 -0
  135. data/lib/elastic_apm/trace_context.rb +85 -49
  136. data/lib/elastic_apm/trace_context/traceparent.rb +113 -0
  137. data/lib/elastic_apm/trace_context/tracestate.rb +43 -0
  138. data/lib/elastic_apm/transaction.rb +33 -5
  139. data/lib/elastic_apm/transport/base.rb +39 -23
  140. data/lib/elastic_apm/transport/connection.rb +17 -0
  141. data/lib/elastic_apm/transport/connection/http.rb +17 -0
  142. data/lib/elastic_apm/transport/connection/proxy_pipe.rb +22 -0
  143. data/lib/elastic_apm/transport/filters.rb +17 -0
  144. data/lib/elastic_apm/transport/filters/hash_sanitizer.rb +77 -0
  145. data/lib/elastic_apm/transport/filters/secrets_filter.rb +29 -53
  146. data/lib/elastic_apm/transport/headers.rb +17 -0
  147. data/lib/elastic_apm/transport/serializers.rb +17 -0
  148. data/lib/elastic_apm/transport/serializers/context_serializer.rb +17 -0
  149. data/lib/elastic_apm/transport/serializers/error_serializer.rb +17 -0
  150. data/lib/elastic_apm/transport/serializers/metadata_serializer.rb +44 -20
  151. data/lib/elastic_apm/transport/serializers/metricset_serializer.rb +17 -0
  152. data/lib/elastic_apm/transport/serializers/span_serializer.rb +22 -2
  153. data/lib/elastic_apm/transport/serializers/transaction_serializer.rb +17 -0
  154. data/lib/elastic_apm/transport/user_agent.rb +17 -0
  155. data/lib/elastic_apm/transport/worker.rb +17 -0
  156. data/lib/elastic_apm/util.rb +17 -0
  157. data/lib/elastic_apm/util/inflector.rb +17 -0
  158. data/lib/elastic_apm/util/lru_cache.rb +17 -0
  159. data/lib/elastic_apm/util/throttle.rb +17 -0
  160. data/lib/elastic_apm/version.rb +18 -1
  161. metadata +29 -12
  162. data/.ci/downstreamTests.groovy +0 -185
  163. data/.ci/prepare-git-context.sh +0 -27
  164. data/CHANGELOG.md +0 -1
  165. data/codecov.yml +0 -32
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 37a020cb4be0022f87d148e568cb6c755bb7464c401141d3f9de743b4f960132
4
- data.tar.gz: e7d34598029f879e51e25b88fa1e23048290e51a21a664818f50b8c3b29bbc34
3
+ metadata.gz: cb0d3e0244586e4fe0b9c89beacd267272c0d6b8467457fcce9fde228b22742e
4
+ data.tar.gz: e3279992b31d2826b6e53c8c66802c1641d30a8b8134671298280b370fa2f8e1
5
5
  SHA512:
6
- metadata.gz: 0f604ede3b49fc35a5560e28841e5d7bcb6c209f3a9c064dbfcfed0db158e75d501dbaec057d148f5254f6077a73de81ae5134ea4001995b614a547edfcb47aa
7
- data.tar.gz: 6f2911e3d564ba2967bf4f3ae583b105c4f56a03014ef47ccfc65dd1ff05d9b6b43530044ed8abff694e38b27db431b50f94d5b0bf69448f52b4b4f29d42fa6a
6
+ metadata.gz: a81c23c3e427e727484854c89072c17704c11fbccca518169ae75a7aa8a45bc04966226044cebcd9c1d36fe7c986053e74e1c1b0456cc6cb23bcd0207204ef9d
7
+ data.tar.gz: de7d4efea50ee03db830ac3570cadc40277fd67ce630c4388f942cfbca005a8b0af72f81b0712eb38972aa7d38c01971fe4697888a75f55ffeba51b98fc51b6b
@@ -1,4 +1,27 @@
1
1
  exclude:
2
+ # Ruby 2.3
3
+ # Only includes rails-5.2, sinatra-2.0
4
+ - RUBY_VERSION: ruby:2.3
5
+ FRAMEWORK: rails-6.0
6
+ - RUBY_VERSION: ruby:2.3
7
+ FRAMEWORK: rails-5.1
8
+ - RUBY_VERSION: ruby:2.3
9
+ FRAMEWORK: rails-5.0
10
+ - RUBY_VERSION: ruby:2.3
11
+ FRAMEWORK: rails-4.2
12
+ - RUBY_VERSION: ruby:2.3
13
+ FRAMEWORK: sinatra-1.4
14
+ - RUBY_VERSION: ruby:2.3
15
+ FRAMEWORK: grape-1.3
16
+ - RUBY_VERSION: ruby:2.3
17
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
18
+ - RUBY_VERSION: ruby:2.3
19
+ FRAMEWORK: rails-master
20
+ - RUBY_VERSION: ruby:2.3
21
+ FRAMEWORK: sinatra-master
22
+ - RUBY_VERSION: ruby:2.3
23
+ FRAMEWORK: grape-master
24
+
2
25
  - RUBY_VERSION: ruby:2.7
3
26
  FRAMEWORK: rails-4.2
4
27
  - RUBY_VERSION: jruby:9.2
@@ -18,8 +41,6 @@ exclude:
18
41
 
19
42
  - RUBY_VERSION: ruby:2.4
20
43
  FRAMEWORK: rails-6.0
21
- - RUBY_VERSION: ruby:2.3
22
- FRAMEWORK: rails-6.0
23
44
  - RUBY_VERSION: jruby:9.1
24
45
  FRAMEWORK: rails-6.0
25
46
  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
@@ -32,8 +53,6 @@ exclude:
32
53
  FRAMEWORK: rails-master
33
54
  - RUBY_VERSION: ruby:2.4
34
55
  FRAMEWORK: rails-master
35
- - RUBY_VERSION: ruby:2.3
36
- FRAMEWORK: rails-master
37
56
  - RUBY_VERSION: jruby:9.2
38
57
  FRAMEWORK: rails-master
39
58
  - RUBY_VERSION: jruby:9.1
@@ -53,8 +72,6 @@ exclude:
53
72
  FRAMEWORK: sinatra-master
54
73
  - RUBY_VERSION: ruby:2.4
55
74
  FRAMEWORK: sinatra-master
56
- - RUBY_VERSION: ruby:2.3
57
- FRAMEWORK: sinatra-master
58
75
  - RUBY_VERSION: jruby:9.2
59
76
  FRAMEWORK: sinatra-master
60
77
  - RUBY_VERSION: jruby:9.1
@@ -76,8 +93,6 @@ exclude:
76
93
  FRAMEWORK: grape-master
77
94
  - RUBY_VERSION: ruby:2.4
78
95
  FRAMEWORK: grape-master
79
- - RUBY_VERSION: ruby:2.3
80
- FRAMEWORK: grape-master
81
96
  - RUBY_VERSION: jruby:9.2
82
97
  FRAMEWORK: grape-master
83
98
  - RUBY_VERSION: jruby:9.1
@@ -93,25 +108,29 @@ exclude:
93
108
  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
94
109
  FRAMEWORK: grape-master
95
110
 
111
+ # Unsupported
112
+ - RUBY_VERSION: jruby:9.1
113
+ FRAMEWORK: grape-1.3
114
+ - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
115
+ FRAMEWORK: grape-1.3
116
+
96
117
  - RUBY_VERSION: ruby:2.6
97
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
118
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
98
119
  - RUBY_VERSION: ruby:2.5
99
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
120
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
100
121
  - RUBY_VERSION: ruby:2.4
101
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
102
- - RUBY_VERSION: ruby:2.3
103
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
122
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
104
123
  - RUBY_VERSION: jruby:9.2
105
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
124
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
106
125
  - RUBY_VERSION: jruby:9.1
107
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
126
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
108
127
  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
109
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
128
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
110
129
  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-12-jdk
111
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
130
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
112
131
  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
113
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
132
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
114
133
  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
115
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
134
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
116
135
  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
117
- FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
136
+ FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
@@ -8,6 +8,6 @@ FRAMEWORK:
8
8
  - sinatra-2.0
9
9
  - sinatra-1.4
10
10
 
11
- - grape-1.2
11
+ - grape-1.3
12
12
 
13
- - grape-1.2,sinatra-2.0,rails-6.0
13
+ - grape-1.3,sinatra-2.0,rails-6.0
@@ -5,16 +5,17 @@ import co.elastic.matrix.*
5
5
  import groovy.transform.Field
6
6
 
7
7
  /**
8
- This is required to store the results of the tests.
8
+ This is the parallel tasks generator,
9
+ it is need as field to store the results of the tests.
9
10
  */
10
- @Field def rubyTasksFailed = false
11
+ @Field def rubyTasksGen
11
12
 
12
13
  pipeline {
13
14
  agent { label 'linux && immutable' }
14
15
  environment {
15
16
  REPO = 'apm-agent-ruby'
16
17
  BASE_DIR = "src/github.com/elastic/${env.REPO}"
17
- PIPELINE_LOG_LEVEL='DEBUG'
18
+ PIPELINE_LOG_LEVEL = 'INFO'
18
19
  NOTIFY_TO = credentials('notify-to')
19
20
  JOB_GCS_BUCKET = credentials('gcs-bucket')
20
21
  CODECOV_SECRET = 'secret/apm-team/ci/apm-agent-ruby-codecov'
@@ -37,7 +38,7 @@ pipeline {
37
38
  quietPeriod(10)
38
39
  }
39
40
  triggers {
40
- issueCommentTrigger('(?i).*(?:jenkins\\W+)?run\\W+(?:the\\W+)?tests(?:\\W+please)?.*')
41
+ issueCommentTrigger('(?i).*(?:jenkins\\W+)?run\\W+(?:the\\W+)?(?:benchmark\\W+)?tests(?:\\W+please)?.*')
41
42
  }
42
43
  parameters {
43
44
  booleanParam(name: 'Run_As_Master_Branch', defaultValue: false, description: 'Allow to run any steps on a PR, some steps normally only run on master branch.')
@@ -54,14 +55,23 @@ pipeline {
54
55
  deleteDir()
55
56
  gitCheckout(basedir: "${BASE_DIR}", githubNotifyFirstTimeContributor: true, reference: "${env.REFERENCE_REPO}")
56
57
  stash allowEmpty: true, name: 'source', useDefaultExcludes: false
58
+ script {
59
+ dir("${BASE_DIR}"){
60
+ // Skip all the stages except docs for PR's with asciidoc and md changes only
61
+ env.ONLY_DOCS = isGitRegionMatch(patterns: [ '.*\\.(asciidoc|md)' ], shouldMatchAll: true)
62
+ }
63
+ }
57
64
  }
58
65
  }
59
66
  stage('Sanity checks') {
60
67
  when {
61
68
  beforeAgent true
62
- anyOf {
63
- not { changeRequest() }
64
- expression { return params.Run_As_Master_Branch }
69
+ allOf {
70
+ expression { return env.ONLY_DOCS == "false" }
71
+ anyOf {
72
+ not { changeRequest() }
73
+ expression { return params.Run_As_Master_Branch }
74
+ }
65
75
  }
66
76
  }
67
77
  options { skipDefaultCheckout() }
@@ -84,169 +94,177 @@ pipeline {
84
94
  /**
85
95
  Execute unit tests.
86
96
  */
87
- stage('Test') {
88
- options { skipDefaultCheckout() }
89
- steps {
90
- withGithubNotify(context: 'Tests', tab: 'tests') {
91
- deleteDir()
92
- unstash "source"
93
- dir("${BASE_DIR}"){
94
- script {
95
- def ruby = readYaml(file: '.ci/.jenkins_ruby.yml')
96
- def testTasks = [:]
97
- ruby['RUBY_VERSION'].each{ rubyVersion ->
98
- testTasks[rubyVersion] = { runJob(rubyVersion) }
99
- }
100
- parallel(testTasks)
101
- }
97
+ stage('Tests') {
98
+ when {
99
+ beforeAgent true
100
+ expression { return env.ONLY_DOCS == "false" }
101
+ }
102
+ failFast false
103
+ parallel {
104
+ stage('Tests') {
105
+ options { skipDefaultCheckout() }
106
+ steps {
107
+ withGithubNotify(context: 'Tests', tab: 'tests') {
108
+ runTests('.ci/.jenkins_framework.yml')
102
109
  }
103
110
  }
104
- }
105
- }
106
- stage('Benchmarks') {
107
- options { skipDefaultCheckout() }
108
- when {
109
- beforeAgent true
110
- allOf {
111
- anyOf {
112
- branch 'master'
113
- branch "\\d+\\.\\d+"
114
- branch "v\\d?"
115
- tag "v\\d+\\.\\d+\\.\\d+*"
116
- expression { return params.Run_As_Master_Branch }
111
+ post {
112
+ always {
113
+ convergeCoverage()
117
114
  }
118
- expression { return params.bench_ci }
119
115
  }
120
116
  }
121
- stages {
122
- stage('Clean Workspace') {
123
- agent { label 'metal' }
124
- steps {
125
- echo "Cleaning Workspace"
126
- }
127
- post {
128
- always {
129
- cleanWs()
130
- }
117
+ stage('Master Tests frameworks') {
118
+ options { skipDefaultCheckout() }
119
+ steps {
120
+ catchError(buildResult: 'SUCCESS', stageResult: 'UNSTABLE', message: "The tests for the master framework have failed. Let's warn instead.") {
121
+ runTests('.ci/.jenkins_master_framework.yml')
131
122
  }
132
123
  }
133
- /**
134
- Run the benchmarks and store the results on ES.
135
- The result JSON files are also archive into Jenkins.
136
- */
137
- stage('Run Benchmarks') {
138
- steps {
139
- withGithubNotify(context: 'Run Benchmarks') {
140
- deleteDir()
141
- unstash 'source'
142
- dir("${BASE_DIR}"){
143
- script {
144
- def versions = readYaml(file: ".ci/.jenkins_ruby.yml")
145
- def benchmarkTask = [:]
146
- // TODO: benchmark for the jruby:9.2 and similar versions got some issues with
147
- // NoMethodError: undefined method `[]' for nil:NilClass
148
- // <main> at bench/report.rb:48
149
- versions['RUBY_VERSION'].findAll { !it.contains('9.2') }.each{ v ->
150
- benchmarkTask[v] = runBenchmark(v)
151
- }
152
- parallel(benchmarkTask)
153
- }
154
- }
155
- }
124
+ }
125
+ stage('Integration Tests') {
126
+ agent none
127
+ when {
128
+ beforeAgent true
129
+ anyOf {
130
+ changeRequest()
131
+ expression { return !params.Run_As_Master_Branch }
156
132
  }
157
133
  }
134
+ steps {
135
+ githubNotify(context: "${env.GITHUB_CHECK_ITS_NAME}", description: "${env.GITHUB_CHECK_ITS_NAME} ...", status: 'PENDING', targetUrl: "${env.JENKINS_URL}search/?q=${env.ITS_PIPELINE.replaceAll('/','+')}")
136
+ build(job: env.ITS_PIPELINE, propagate: false, wait: true,
137
+ parameters: [ string(name: 'INTEGRATION_TEST', value: 'Ruby'),
138
+ string(name: 'BUILD_OPTS', value: "--ruby-agent-version ${env.GIT_BASE_COMMIT} --ruby-agent-version-state ${env.GIT_BUILD_CAUSE} --ruby-agent-repo ${env.CHANGE_FORK?.trim() ?: 'elastic'}/${env.REPO} --opbeans-ruby-agent-branch ${env.GIT_BASE_COMMIT}"),
139
+ string(name: 'GITHUB_CHECK_NAME', value: env.GITHUB_CHECK_ITS_NAME),
140
+ string(name: 'GITHUB_CHECK_REPO', value: env.REPO),
141
+ string(name: 'GITHUB_CHECK_SHA1', value: env.GIT_BASE_COMMIT) ])
142
+ }
158
143
  }
159
144
  }
160
- stage('Populate Test failures') {
161
- when {
162
- expression { return rubyTasksFailed }
163
- }
164
- steps {
165
- error('There were some failures when running the "Test" stage')
166
- }
167
- }
168
- stage('Integration Tests') {
169
- agent none
170
- when {
171
- beforeAgent true
145
+ }
146
+ stage('Benchmarks') {
147
+ options { skipDefaultCheckout() }
148
+ when {
149
+ beforeAgent true
150
+ allOf {
172
151
  anyOf {
173
- changeRequest()
174
- expression { return !params.Run_As_Master_Branch }
152
+ branch 'master'
153
+ branch "\\d+\\.\\d+"
154
+ branch "v\\d?"
155
+ tag pattern: 'v\\d+.*', comparator: "REGEXP"
156
+ expression { return params.Run_As_Master_Branch }
157
+ expression { return env.GITHUB_COMMENT?.contains('benchmark tests') }
175
158
  }
176
- }
177
- steps {
178
- log(level: 'INFO', text: 'Launching Async ITs')
179
- build(job: env.ITS_PIPELINE, propagate: false, wait: false,
180
- parameters: [string(name: 'AGENT_INTEGRATION_TEST', value: 'Ruby'),
181
- string(name: 'BUILD_OPTS', value: "--ruby-agent-version ${env.GIT_BASE_COMMIT} --ruby-agent-version-state ${env.GIT_BUILD_CAUSE} --ruby-agent-repo ${env.CHANGE_FORK?.trim() ?: 'elastic'}/${env.REPO}"),
182
- string(name: 'GITHUB_CHECK_NAME', value: env.GITHUB_CHECK_ITS_NAME),
183
- string(name: 'GITHUB_CHECK_REPO', value: env.REPO),
184
- string(name: 'GITHUB_CHECK_SHA1', value: env.GIT_BASE_COMMIT)]
185
- )
186
- githubNotify(context: "${env.GITHUB_CHECK_ITS_NAME}", description: "${env.GITHUB_CHECK_ITS_NAME} ...", status: 'PENDING', targetUrl: "${env.JENKINS_URL}search/?q=${env.ITS_PIPELINE.replaceAll('/','+')}")
159
+ expression { return params.bench_ci }
187
160
  }
188
161
  }
189
- stage('Release') {
190
- options { skipDefaultCheckout() }
191
- environment {
192
- RUBY_DOCKER_TAG = 'ruby:2.6'
193
- HOME = '/var/lib/jenkins'
194
- }
195
- when {
196
- beforeAgent true
197
- tag pattern: 'v\\d+.*', comparator: 'REGEXP'
162
+ stages {
163
+ stage('Clean Workspace') {
164
+ agent { label 'metal' }
165
+ steps {
166
+ echo "Cleaning Workspace"
167
+ }
168
+ post {
169
+ always {
170
+ cleanWs()
171
+ }
172
+ }
198
173
  }
199
- stages {
200
- stage('Release') {
201
- steps {
202
- withGithubNotify(context: 'Release') {
203
- deleteDir()
204
- unstash 'source'
174
+ /**
175
+ Run the benchmarks and store the results on ES.
176
+ The result JSON files are also archive into Jenkins.
177
+ */
178
+ stage('Run Benchmarks') {
179
+ steps {
180
+ withGithubNotify(context: 'Run Benchmarks') {
181
+ deleteDir()
182
+ unstash 'source'
183
+ dir("${BASE_DIR}"){
205
184
  script {
206
- dir(BASE_DIR){
207
- docker.image("${env.RUBY_DOCKER_TAG}").inside('-v ${REFERENCE_REPO}:${REFERENCE_REPO} -v /etc/passwd:/etc/passwd -v ${HOME}/.ssh:${HOME}/.ssh') {
208
- withEnv(["HOME=${env.WORKSPACE}/${env.BASE_DIR ?: ''}"]) {
209
- rubygemsLogin.withApi(secret: "${env.RELEASE_SECRET}") {
210
- sshagent(['f6c7695a-671e-4f4f-a331-acdce44ff9ba']) {
211
- sh '.ci/prepare-git-context.sh'
212
- sh 'gem install rake yard rspec'
213
- sh 'rake release'
214
- }
215
- }
216
- }
217
- }
185
+ def versions = readYaml(file: ".ci/.jenkins_ruby.yml")
186
+ def benchmarkTask = [:]
187
+ versions['RUBY_VERSION'].each{ v ->
188
+ benchmarkTask[v] = runBenchmark(v)
218
189
  }
190
+ parallel(benchmarkTask)
219
191
  }
220
192
  }
221
193
  }
222
194
  }
223
- stage('Opbeans') {
224
- environment {
225
- REPO_NAME = "${OPBEANS_REPO}"
195
+ }
196
+ }
197
+ }
198
+ stage('Release') {
199
+ options { skipDefaultCheckout() }
200
+ environment {
201
+ RUBY_DOCKER_TAG = 'ruby:2.6'
202
+ HOME = '/var/lib/jenkins'
203
+ }
204
+ when {
205
+ beforeAgent true
206
+ tag pattern: 'v\\d+.*', comparator: 'REGEXP'
207
+ }
208
+ stages {
209
+ stage('Release') {
210
+ steps {
211
+ deleteDir()
212
+ unstash 'source'
213
+ prepareRelease(){
214
+ sh 'rake release'
226
215
  }
227
- steps {
228
- deleteDir()
229
- dir("${OPBEANS_REPO}"){
230
- git credentialsId: 'f6c7695a-671e-4f4f-a331-acdce44ff9ba',
231
- url: "git@github.com:elastic/${OPBEANS_REPO}.git"
232
- // It's required to transform the tag value to the gem version
233
- sh script: ".ci/bump-version.sh ${env.BRANCH_NAME.replaceAll('^v', '')}", label: 'Bump version'
234
- // The opbeans pipeline will trigger a release for the master branch
235
- gitPush()
236
- // The opbeans pipeline will trigger a release for the release tag
237
- gitCreateTag(tag: "${env.BRANCH_NAME}")
216
+ }
217
+ }
218
+ stage('Update Branch') {
219
+ steps {
220
+ deleteDir()
221
+ unstash 'source'
222
+ prepareRelease(){
223
+ catchError(buildResult: 'SUCCESS', message: 'Update branch task failed', stageResult: 'UNSTABLE') {
224
+ sh 'rake release:update_branch'
238
225
  }
239
226
  }
240
227
  }
228
+ post {
229
+ unsuccessful {
230
+ emailext subject: "[${env.REPO}] Syncup post-release stage failed.", to: "${NOTIFY_TO}",
231
+ body: "Please go to ${env.BUILD_URL} to review the logs. Most likely you need to update the branch manually."
232
+ }
233
+ }
234
+ }
235
+ stage('Opbeans') {
236
+ environment {
237
+ REPO_NAME = "${OPBEANS_REPO}"
238
+ VERSION = "${env.BRANCH_NAME.replaceAll('^v', '')}"
239
+ }
240
+ steps {
241
+ deleteDir()
242
+ // Let's wait for the Gem to be available
243
+ sh label: 'Wait for gem', script: """#!/usr/bin/env bash
244
+ source /usr/local/bin/bash_standard_lib.sh
245
+ (retry 10 curl --silent --show-error --fail -I https://rubygems.org/gems/elastic-apm/versions/${env.VERSION})
246
+ """
247
+ dir("${OPBEANS_REPO}"){
248
+ git credentialsId: 'f6c7695a-671e-4f4f-a331-acdce44ff9ba',
249
+ url: "git@github.com:elastic/${OPBEANS_REPO}.git"
250
+ // It's required to transform the tag value to the gem version
251
+ sh script: ".ci/bump-version.sh ${env.VERSION}", label: 'Bump version'
252
+ // The opbeans pipeline will trigger a release for the master branch
253
+ gitPush()
254
+ // The opbeans pipeline will trigger a release for the release tag
255
+ gitCreateTag(tag: "${env.BRANCH_NAME}")
256
+ }
257
+ }
241
258
  }
242
259
  }
243
260
  }
244
- post {
245
- cleanup {
246
- notifyBuildResult()
247
- }
261
+ }
262
+ post {
263
+ cleanup {
264
+ notifyBuildResult()
248
265
  }
249
266
  }
267
+ }
250
268
 
251
269
  /**
252
270
  Run benchmarks for a Ruby version, then report the results to the Elasticsearch server.
@@ -258,26 +276,64 @@ def runBenchmark(version){
258
276
  // - docker.elastic.co/observability-ci/jruby:9.2-12-jdk to jruby-9.2-12-jdk
259
277
  // - jruby:9.1 to jruby-9.1
260
278
  def transformedVersion = version.replaceAll('.*/', '').replaceAll(':', '-')
261
- env.HOME = "${env.WORKSPACE}/${transformedVersion}"
262
- dir("${transformedVersion}"){
263
- deleteDir()
264
- unstash 'source'
265
- dir("${BASE_DIR}"){
266
- retry(2){
267
- sleep randomNumber(min:10, max: 30)
268
- dockerLogin(secret: "${DOCKER_SECRET}", registry: "${DOCKER_REGISTRY}")
279
+ withEnv(["HOME=${env.WORKSPACE}/${transformedVersion}"]){
280
+ dir("${transformedVersion}"){
281
+ deleteDir()
282
+ unstash 'source'
283
+ dir("${BASE_DIR}"){
284
+ retry(2){
285
+ sleep randomNumber(min:10, max: 30)
286
+ dockerLogin(secret: "${DOCKER_SECRET}", registry: "${DOCKER_REGISTRY}")
287
+ }
288
+ try{
289
+ sh """./spec/scripts/benchmarks.sh "${version}" "${REFERENCE_REPO}" """
290
+ } catch(e){
291
+ throw e
292
+ } finally {
293
+ archiveArtifacts(
294
+ allowEmptyArchive: true,
295
+ artifacts: "**/benchmark-${transformedVersion}.raw,**/benchmark-${transformedVersion}.error",
296
+ onlyIfSuccessful: false)
297
+ sendBenchmarks(file: "benchmark-${transformedVersion}.bulk",
298
+ index: "benchmark-ruby", archive: true)
299
+ }
269
300
  }
270
- try{
271
- sh "./spec/scripts/benchmarks.sh ${version}"
272
- } catch(e){
273
- throw e
274
- } finally {
275
- archiveArtifacts(
276
- allowEmptyArchive: true,
277
- artifacts: "**/benchmark-${transformedVersion}.raw,**/benchmark-${transformedVersion}.error",
278
- onlyIfSuccessful: false)
279
- sendBenchmarks(file: "benchmark-${transformedVersion}.bulk",
280
- index: "benchmark-ruby", archive: true)
301
+ }
302
+ }
303
+ }
304
+ }
305
+ }
306
+
307
+ class RubyParallelTaskGenerator extends DefaultParallelTaskGenerator {
308
+
309
+ public RubyParallelTaskGenerator(Map params){
310
+ super(params)
311
+ }
312
+
313
+ /**
314
+ build a clousure that launch and agent and execute the corresponding test script,
315
+ then store the results.
316
+ */
317
+ public Closure generateStep(x, y){
318
+ return {
319
+ steps.sleep steps.randomNumber(min:10, max: 30)
320
+ steps.node('linux && immutable'){
321
+ // Label is transformed to avoid using the internal docker registry in the x coordinate
322
+ // TODO: def label = "${tag}:${x?.drop(x?.lastIndexOf('/')+1)}#${y}"
323
+ def label = "${tag}:${x}#${y}"
324
+ try {
325
+ steps.runScript(label: label, ruby: x, framework: y)
326
+ saveResult(x, y, 1)
327
+ } catch(e){
328
+ saveResult(x, y, 0)
329
+ steps.error("${label} tests failed : ${e.toString()}\n")
330
+ } finally {
331
+ steps.junit(allowEmptyResults: false,
332
+ keepLongStdio: true,
333
+ testResults: "**/spec/junit-reports/**/ruby-agent-junit.xml")
334
+ steps.dir("${steps.env.BASE_DIR}"){
335
+ steps.archiveArtifacts(artifacts: 'coverage/matrix_results/', defaultExcludes: false)
336
+ steps.stash(name: steps.normalise("coverage-${x}-${y}"), includes: 'coverage/matrix_results/', allowEmpty: true)
281
337
  }
282
338
  }
283
339
  }
@@ -285,19 +341,79 @@ def runBenchmark(version){
285
341
  }
286
342
  }
287
343
 
288
- def runJob(rubyVersion){
289
- try {
290
- build( job: "apm-agent-ruby/apm-agent-ruby-downstream/${env.BRANCH_NAME}",
291
- parameters: [
292
- string(name: 'RUBY_VERSION', value: "${rubyVersion}"),
293
- string(name: 'BRANCH_SPECIFIER', value: "${env.GIT_BASE_COMMIT}")
294
- ],
295
- quietPeriod: 15
344
+ /**
345
+ Run all the tests for the given file with the frameworks to test
346
+ */
347
+ def runTests(frameworkFile) {
348
+ deleteDir()
349
+ unstash "source"
350
+ dir("${BASE_DIR}"){
351
+ rubyTasksGen = new RubyParallelTaskGenerator(
352
+ xKey: 'RUBY_VERSION',
353
+ yKey: 'FRAMEWORK',
354
+ xFile: ".ci/.jenkins_ruby.yml",
355
+ yFile: frameworkFile,
356
+ exclusionFile: ".ci/.jenkins_exclude.yml",
357
+ tag: "Ruby",
358
+ name: "Ruby",
359
+ steps: this
296
360
  )
297
- } catch(e) {
298
- rubyTasksFailed = true
299
- warnError('Test Failures') {
300
- error("Downstream job for '${rubyVersion}' failed")
361
+ def testTasks = rubyTasksGen.generateParallelTests()
362
+ parallel(testTasks)
363
+ }
364
+ }
365
+
366
+ /**
367
+ Run tests for a Ruby version and framework version.
368
+ */
369
+ def runScript(Map params = [:]){
370
+ def label = params.label
371
+ def ruby = params.ruby
372
+ def framework = params.framework
373
+ log(level: 'INFO', text: "${label}")
374
+ retry(2){
375
+ withEnv(["HOME=${env.WORKSPACE}", "PATH=${env.PATH}:${env.WORKSPACE}/bin"]) {
376
+ deleteDir()
377
+ unstash 'source'
378
+ dir("${BASE_DIR}"){
379
+ sleep randomNumber(min:10, max: 30)
380
+ dockerLogin(secret: "${DOCKER_SECRET}", registry: "${DOCKER_REGISTRY}")
381
+ sh("./spec/scripts/spec.sh ${ruby} ${framework}")
382
+ }
301
383
  }
302
384
  }
303
385
  }
386
+
387
+ def convergeCoverage() {
388
+ deleteDir()
389
+ unstash('source')
390
+ dir("${BASE_DIR}"){
391
+ rubyTasksGen.dumpMatrix('-')?.each {
392
+ unstash(normalise("coverage-${it}"))
393
+ }
394
+ sh(script: './spec/scripts/coverage_converge.sh')
395
+ cobertura coberturaReportFile: 'coverage/coverage.xml', onlyStable: false
396
+ }
397
+ }
398
+
399
+ def prepareRelease(Closure body){
400
+ dir("${env.BASE_DIR}"){
401
+ docker.image("${env.RUBY_DOCKER_TAG}").inside('-v ${REFERENCE_REPO}:${REFERENCE_REPO} -v /etc/passwd:/etc/passwd -v ${HOME}/.ssh:${HOME}/.ssh') {
402
+ withEnv(["HOME=${env.WORKSPACE}/${env.BASE_DIR ?: ''}"]) {
403
+ rubygemsLogin.withApi(secret: "${env.RELEASE_SECRET}") {
404
+ withGitRelease(credentialsId: '2a9602aa-ab9f-4e52-baf3-b71ca88469c7-UserAndToken') {
405
+ sh 'gem install rake yard rspec'
406
+ body()
407
+ }
408
+ }
409
+ }
410
+ }
411
+ }
412
+ }
413
+
414
+ // Transform the versions like:
415
+ // - docker.elastic.co/observability-ci/jruby:9.2-12-jdk to jruby-9.2-12-jdk
416
+ // - jruby:9.1 to jruby-9.1
417
+ def normalise(def what) {
418
+ return what.replaceAll('.*/', '').replaceAll(':', '-')
419
+ }