AC/FC integration #2995

kaylareopelle · 2024-12-12T23:58:51Z

Resolves #2859

When the agent recognizes it is running in an agent control environment, it will start automatic health checks that will create a new file at a configured destination at a given frequency that provides details about the last reported status of the agent. When the agent is not seen within an agent control environment, files will not be created.

CHANGELOG.md

lib/new_relic/agent/configuration/default_source.rb

lib/new_relic/agent/health_check.rb

test/new_relic/agent/health_check_test.rb

lib/new_relic/agent/health_check.rb

Instead of creating a new file at the interval, reuse the same file for the life of the process.

The array was not being correctly destructured, which would raise an error when the status was HTTP_ERROR

The health check status may be updated for other reasons on the CI, which may cause the message to be inaccurate by the time the result is accessed from the hash

There was a bug related to the HTTP_ERROR constant, where the sprintf string manipulation changed the constant to equal the first value it came across. By freezing the constants and dup'ing the status before assigning it, we can avoid this problem.

Previously the invalid license key status would be set, but the health check files would not be written until the first request to the web app was made. Now, health checks will begin before the agent officially starts.

…gent into sa-health-check

lib/new_relic/agent/health_check.rb

tannalynn

couple of questions and noticed some puts, wanted to comment on them just to make sure they dont get forgotten in the future.

lib/new_relic/agent/configuration/default_source.rb

lib/new_relic/agent/health_check.rb

test/new_relic/agent/agent/start_test.rb

CHANGELOG.md

lib/new_relic/agent/health_check.rb

CHANGELOG.md

test/new_relic/agent/health_check_test.rb

Co-authored-by: Hannah Ramadan <[email protected]>

CHANGELOG.md

Make sure the SHUTDOWN status is only applied when the agent is healthy

…gent into sa-health-check

Instead of waiting until create_and_run_health_check_loop is run to verify the necessary config options are present, evaluate whether checks are enabled on initialization. In addition, log the status of the config-related instance variables during initialization.

github-actions · 2025-01-15T01:02:25Z

SimpleCov Report

	Coverage	Threshold
Line	93.57%	93%

The fleet ID setting has been replaced by agent_control.enabled. At this time, enabled will only refer to health checks being enabled. The value is a Boolean and defaults to false.

The default value is '/newrelic/apm/health' in the code, though the spec default is 'file:///newrelic/apm/health'. Since we need to remove the 'file://' anyway, take it out when defining the string to avoid unncessary gsubs

* Add link to Agent Control documentation * Add environment variable detail to config description * Capitalize Agent Control in logs and docs

kaylareopelle · 2025-01-17T01:45:07Z

lib/new_relic/agent/health_check.rb

+        @continue = false
+      end
+
+      def create_file_path


Keep an eye on the spec for this; we may not need to create the path if it doesn't exist.

kaylareopelle force-pushed the sa-health-check branch from 1870dc2 to 671edf2 Compare January 7, 2025 00:12

kaylareopelle changed the title ~~WIP: AC/FC integration~~ AC/FC integration Jan 7, 2025

Indent HEREDOC contents

a510eb2

kaylareopelle commented Jan 7, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

kaylareopelle commented Jan 7, 2025

View reviewed changes

kaylareopelle marked this pull request as ready for review January 7, 2025 01:16

kaylareopelle requested review from hannahramadan and tannalynn as code owners January 7, 2025 01:16

chynesNR reviewed Jan 7, 2025

View reviewed changes

lib/new_relic/agent/health_check.rb Outdated Show resolved Hide resolved

kaylareopelle and others added 11 commits January 7, 2025 10:22

Set frequency default to 5 on HealthCheck init

e5ad084

Write to a single file per agent instance

f333e68

Instead of creating a new file at the interval, reuse the same file for the life of the process.

Update array destructure for update_message

aa4409d

The array was not being correctly destructured, which would raise an error when the status was HTTP_ERROR

Rubocop

95808e8

Update test expectation

0d55f7d

The health check status may be updated for other reasons on the CI, which may cause the message to be inaccurate by the time the result is accessed from the hash

Freeze and dup HealthCheck constants

20cdad8

There was a bug related to the HTTP_ERROR constant, where the sprintf string manipulation changed the constant to equal the first value it came across. By freezing the constants and dup'ing the status before assigning it, we can avoid this problem.

Update lib/new_relic/agent/configuration/default_source.rb

9538c38

Start health check loop before license key checked

9d01044

Previously the invalid license key status would be set, but the health check files would not be written until the first request to the web app was made. Now, health checks will begin before the agent officially starts.

Merge branch 'sa-health-check' of github.com:newrelic/newrelic-ruby-a…

aab917f

…gent into sa-health-check

Add tests for update_status

5499054

Remove remaining :: before NewRelic::Agent

8f257f2

kaylareopelle commented Jan 14, 2025

View reviewed changes

lib/new_relic/agent/health_check.rb Outdated Show resolved Hide resolved

kaylareopelle added 6 commits January 13, 2025 17:27

Enable health checks in monitoring? test

3b45b9d

get => set

eb1e8fb

Undo :: change

267a58f

Add debugging for CI failure

ac1bc31

rubocop

53d1b1d

Add check for else

21e65c9

tannalynn reviewed Jan 14, 2025

View reviewed changes

hannahramadan reviewed Jan 14, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

lib/new_relic/agent/health_check.rb Outdated Show resolved Hide resolved

Remove puts, use correct config name in test

29067ea

kaylareopelle commented Jan 14, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

test/new_relic/agent/health_check_test.rb Outdated Show resolved Hide resolved

kaylareopelle and others added 2 commits January 14, 2025 16:22

Merge branch 'dev' into sa-health-check

9e943df

Apply suggestions from code review

05ef5e4

Co-authored-by: Hannah Ramadan <[email protected]>

kaylareopelle commented Jan 15, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

kaylareopelle added 3 commits January 14, 2025 16:43

Add healthy? to health check

b3b6766

Make sure the SHUTDOWN status is only applied when the agent is healthy

Merge branch 'sa-health-check' of github.com:newrelic/newrelic-ruby-a…

ac40640

…gent into sa-health-check

kaylareopelle added 3 commits January 16, 2025 17:05

agent_control.fleet_id => agent_control.enabled

9dc3cd4

The fleet ID setting has been replaced by agent_control.enabled. At this time, enabled will only refer to health checks being enabled. The value is a Boolean and defaults to false.

Set default value for delivery location

5ab814b

The default value is '/newrelic/apm/health' in the code, though the spec default is 'file:///newrelic/apm/health'. Since we need to remove the 'file://' anyway, take it out when defining the string to avoid unncessary gsubs

Update documentation

a1bcd2a

* Add link to Agent Control documentation * Add environment variable detail to config description * Capitalize Agent Control in logs and docs

kaylareopelle commented Jan 17, 2025

View reviewed changes

kaylareopelle and others added 2 commits January 17, 2025 14:34

Merge branch 'dev' into sa-health-check

d85904b

Rubocop - Minitest/EmptyLineBeforeAssertionMethods

0c06889

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AC/FC integration #2995

AC/FC integration #2995

kaylareopelle commented Dec 12, 2024

tannalynn left a comment

github-actions bot commented Jan 15, 2025

kaylareopelle Jan 17, 2025

AC/FC integration #2995

Are you sure you want to change the base?

AC/FC integration #2995

Conversation

kaylareopelle commented Dec 12, 2024

tannalynn left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 15, 2025

SimpleCov Report

kaylareopelle Jan 17, 2025

Choose a reason for hiding this comment