Add a GRPC listener service for Agent #18827
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Pinging @elastic/ingest-management (Team:Ingest Management) |
botelastic
bot
added
needs_team
|
@graphaelli I believe you are using gRPC in apm-server, we are planning to update the vendor version on our side. Not sure if that has an impact on you or not? |
💔 Tests Failed
Expand to view the summary
Build stats
Test stats 🧪
Test errorsExpand to view the tests failures
Steps errorsExpand to view the steps failures
Log outputExpand to view the last 100 lines of log output
|
5 tasks
|
This is actually dependent on #18829, because of the usage of |
|
Thanks for the heads up, broadening to @elastic/apm-server |
|
Thanks for the heads up @ph. I just tested updating apm-server's grpc to v1.29.1, and it appears to be fine. |
michalpristas
approved these changes
May 29, 2020
| statusMessage string | ||
| statusConfigIdx uint64 | ||
| statusTime time.Time | ||
| checkinConn bool |
There was a problem hiding this comment.
could you think about different name please? i imagine a connection itself under this name, something like isCheckingConnected, hasCheckingConnection...
|
|
||
| pendingActions chan *pendingAction | ||
| sentActions map[string]*sentAction | ||
| actionsConn bool |
| sentActions: make(map[string]*sentAction), | ||
| actionsConn: true, | ||
| } | ||
| s.lock.Lock() |
There was a problem hiding this comment.
can it be that in between get and set another set happens? in agent we do thing sync so it should be fine
| func (s *Server) Checkin(server proto.ElasticAgent_CheckinServer) error { | ||
| firstCheckinChan := make(chan *proto.StateObserved) | ||
| go func() { | ||
| // go func will not be leaked, because when the main function |
There was a problem hiding this comment.
👍 for comments about when go routine is done
| if err != nil { | ||
| // failed to send action; add back to channel to retry on re-connect from the client | ||
| appState.actionsLock.Unlock() | ||
| appState.pendingActions <- pending |
There was a problem hiding this comment.
food for thought: can out of order application of actions be an issue? [not a blocker]
There was a problem hiding this comment.
I don't see why they would be out of order we append them to the pendingAction channel?
There was a problem hiding this comment.
you have A1, A2, A3,
A1 fails so it is sent to pendingActions channel which is buffered up to 100 items. then you will proceed with A2 and A3 and then A1 is there again from channel
There was a problem hiding this comment.
@michalpristas is correct on the ordering. But its not an issue because the actions on the client side are not blocking when it comes from reading from the stream.
So even if it goes A2, A3, A1 all 3 will be executed at the same time. Now on Agent side the PerformAction is blocking, even though the communication is not.
So the order of actions is still serial on Agent side:
PerformAction("action1") // block waiting for response
PerformAction("action2"). // this wont even be added to the channel until action1 completes, fails, or timesout
ph
approved these changes
May 29, 2020
| @@ -434,6 +440,7 @@ def detect_license_summary(content): | |||
| "MPL-2.0", | |||
| "UPL-1.0", | |||
| "ISC", | |||
| "ELASTIC", | |||
| ] | |||
| SKIP_NOTICE = [] | |||
|
|
|||
| if err != nil { | ||
| // failed to send action; add back to channel to retry on re-connect from the client | ||
| appState.actionsLock.Unlock() | ||
| appState.pendingActions <- pending |
There was a problem hiding this comment.
I don't see why they would be out of order we append them to the pendingAction channel?
| ConfigStateIdx: as.statusConfigIdx, // stopping always inform that the config it has is correct | ||
| Config: "", | ||
| } | ||
| } else if checkin.ConfigStateIdx != as.expectedConfigIdx { |
There was a problem hiding this comment.
should this check also be covered in the lock above should we indeed defer the unlock of the struct?
There was a problem hiding this comment.
I have added it into the lock as well, thanks for pointing that out.
| s := prevStatus | ||
| prevMessage := serverApp.statusMessage | ||
| message := prevMessage | ||
| if serverApp.status == proto.StateObserved_DEGRADED { |
There was a problem hiding this comment.
Will, we ever try to restart a process if the watchdog doesn't have news of the client for an extended period of time, I am curious what would be the actions required to recover from that state? (can be a followup)
There was a problem hiding this comment.
i think we can add a hook here and decide later, with forking we have a watchdog for process to be killed so it could handle also this callback
There was a problem hiding this comment.
Yes that is what the OnStatusChange is given when the server is started. We will add the logic in that callback to handle when an application is marked FAILED.
|
Removing the requirement for go 1.14 requires elastic/elastic-agent-client#9 to land so I can vendor it into this PR. |
blakerouse
force-pushed
the
agent-grpc-server
branch
from
a56aa73
to
320259c
Compare
4 tasks
blakerouse
added a commit
to blakerouse/beats
that referenced
this pull request
Jun 1, 2020
* Work on the GRPC server for agent. * Lots of testing. * Fix data races. * Add support for elastic license in generate_notice.py. * Update to generate server name unique per application. * Fix go vet on stackdriver metricset using latest protobuf. * Fix data race issue. * Fix tests. (cherry picked from commit 6e91ce4)
v1v
added a commit
to v1v/beats
that referenced
this pull request
Jun 2, 2020
…-stage-level * upstream/master: (30 commits) Add a GRPC listener service for Agent (elastic#18827) Disable host.* fields by default for iptables module (elastic#18756) [WIP] Clarify capabilities of the Filebeat auditd module (elastic#17068) fix: rename file and remove extra separator (elastic#18881) ci: enable JJBB (elastic#18812) Disable host.* fields by default for Checkpoint module (elastic#18754) Disable host.* fields by default for Cisco module (elastic#18753) Update latest.yml testing env to 7.7.0 (elastic#18535) Upgrade k8s.io/client-go and k8s keystore tests (elastic#18817) Add missing Jenkins stages for Auditbeat (elastic#18835) [Elastic Log Driver] Create a config shim between libbeat and the user (elastic#18605) Use indexers and matchers in config when defaults are enabled (elastic#18818) Fix panic on `metricbeat test modules` (elastic#18797) [CI] Fix permissions in MacOSX agents (elastic#18847) [Ingest Manager] When not port are specified and the https is used fallback to 443 (elastic#18844) [Ingest Manager] Fix install service script for windows (elastic#18814) [Metricbeat] Fix getting compute instance metadata with partial zone/region config (elastic#18757) Improve error messages in s3 input (elastic#18824) Add memory metrics into compute googlecloud (elastic#18802) include bucket name when logging error (elastic#18679) ...
blakerouse
added a commit
that referenced
this pull request
Jun 2, 2020
* Work on the GRPC server for agent. * Lots of testing. * Fix data races. * Add support for elastic license in generate_notice.py. * Update to generate server name unique per application. * Fix go vet on stackdriver metricset using latest protobuf. * Fix data race issue. * Fix tests. (cherry picked from commit 6e91ce4)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds a GRPC server implementation to the Elastic Agent. This is just the implementation, the server is not actually used by the Elastic Agent (coming in later PR).
The GRPC server maintains the currently reported status of an application (connected or not connected). Pushes config updates to the application and informs the application when to stop. A watchdog is included in the server to ensure that the application checkin every 30 seconds if not then the first missed window of time the application will be marked degraded and then after another missed window (total of 60 seconds) the application will be marked failed (currently nothing is done at this point, follow up PR will add the kill/restart logic).
Actions are also handled by the GRPC server implementation, even across connections and disconnections, including timeout of operations. A action can timeout or be cancelled depending on the application state in the GRPC server.
Usage:
Why is it important?
This is need as the contract between Elastic Agent and the spawned applications has flipped where the applications now connecting back to the Agent. Support for stopping and performing actions on application was also required this PR adds those required building blocks.
Checklist
I have made corresponding changes to the documentationI have made corresponding change to the default configuration filesI have added an entry inCHANGELOG.next.asciidocorCHANGELOG-developer.next.asciidoc.Author's Checklist
go test -race github.com/elastic/beats/v7/x-pack/elastic-agent/pkg/core/serverHow to test this PR locally
Related issues