feat: streaming terraform logs in real-time #1937

Aayyush · 2021-12-14T18:28:19Z

This feature allows users to view their terraform logs in real time when running atlantis plan/apply commands. This implementation uses websockets to stream the logs from the terraform client to the user's web browser.

How to use it?

Comment atlantis plan/apply command on any PR as usual.
The github status checks will update with links to the log-streaming UI for every workspace for every project in the PR. If a workspace is not set, it defaults to a default workspace.
Click on the link to view real-time terraform logs for your command.

This is inspired from @raxod502-plaid initial implementation outlined in this PR: #1315

Contributors: @isatasan @nishkrishnan @msarvar @Aayyush

* Current progress * Websocket implementation * Fixing routes * Adding url * Fixed websocket connection * Progress 7/9 * UI Fixes * Fixed test * Fixing failed tests * Update server/controllers/templates/web_templates.go Co-authored-by: Sarvar Muminov <43311+msarvar@users.noreply.github.com> * Update server/events/models/models.go Co-authored-by: Sarvar Muminov <43311+msarvar@users.noreply.github.com> Co-authored-by: Isata Sankoh <isatas@lyft.com> Co-authored-by: Isata Sankoh <85632667+isatasan@users.noreply.github.com>

* Current progress * Websocket implementation * Fixing routes * Adding url * Fixed websocket connection * Progress 7/9 * Added some channel logic * Changes to models.go * Working on log streaming for plan * Beginning tests/Having errors * Log Streaming Logic * fixed test * Added Testing * Fixed websocket connection * Async implementation and test error fixes * Changes to variables in tests * Debugging * Fixed UI in webpage terminal * Fixing Run make-test coverage * Fixing tests * Testing * Deleted txt.act files * Fixing broken tests * Changes to terraform_client testing * Fixed tests in terraform_client_internal_test.go * Fixed failing test * Deleted lines causing test to fail * Reformating * More Reformatting * Run make check-lint corrections * Added error check * Fixing check-lint test * Suggested changes prior to merge Co-authored-by: Isata Sankoh <isatas@lyft.com>

This reverts commit a9e1712.

* Began channel refactoring * Fixing refactoring logic * Replacing terraformOutputChan * Making suggested changes * Changing attribute declarations * Fixed channel logic * Formatting * Changing tests to utilize mocks * Adding go files * Adding suggested changes * Suggested changes before merging * Reformatting * Deleting unnecesary lines * Buffer cleanup logic * Buffer cleanup & Testing * Trying to make test pass * Suggested changes * Fixing test * Fixing failing test * Error checking * Comment improvements * Adding buffer clearing for apply workflow * Removing clearing for apply workflow

* Adding URLs to PR * Changes for rebasing * Minor changes in comments * Removing unnecessary comments * Fixing bug in PR * Minor changes in comments * Removing unnecessary comments * Removing extra character * Allocating comments created in PR * Adding feature allocator to structs

* renaming log-streaming to jobs * Create a status per running project * Add SetJobUrlWithStatus to ProjectCommandOutputHandler It implements updating the PR with a new project status and adds URL to a project jobs page where customer can view the progress of their terraform command execution in realtime. * Added feature allocator into the project command output handler * Remove PullRequestJobs objects and structs * remove print statement * remove print * Adding feature allocator mocks to tests * fix tests * Fixing linting * fix linting * Add decorator with feature allocator * use different variable name * Moved logic into a decorator * fix e2e test * Address PR comments

* Do not display non essential tf commands * Add title with correct tabbing * fix ui issues * more fixes

* So for whatever reason tf show with big plan doesn't work in async * rename isValidCommand to isAsyncEligibleCommand

#144) is enabled

A number of things are going on here: Removed the feature aware related items for log streaming work Created websocket package which handles writing to individual websockets Created Multiplexor which primarily should be all the controller interacts with and moved all primary logic there Created PartitionKeyGenerator for pulling the projectinfo which makes it generic. Modified Receive/removeChan -> Register/Deregister to remove the reading logic from the outputhandler since that struct has way too many responsibilities right now.

msarvar · 2021-12-17T17:36:48Z

@Aayyush it is safe to delete all *.act files, they were merged on accident.

server/controllers/websocket/writer.go

server/events/pull_closed_executor.go

nishkrishnan

Did a first pass looks good, its worth calling out that we've been running this in production for a few months so the only risk with a large PR like this is maybe some weirdness with merging or with workflows that others in the community use that we don't.

This reverts commit 781ab37.

karimbouchouicha · 2021-12-30T17:45:11Z

Hello,
Does it also work with other source control tools like bitbucket? Because I keep getting a black screen without any logs
I am running v0.18.0
Thanks

…-test-job * 'master' of github.com:runatlantis/atlantis: (79 commits) release: 0.18.0 (#1965) feat: streaming terraform logs in real-time (#1937) build(deps): bump github.com/hashicorp/go-getter from 1.5.9 to 1.5.10 (#1961) docs: update website links (#1964) docs: clarify example for `--azuredevops-token` flag (#1712) docs: typo in heading level (#1960) fix: fallback to default TF version in apply step (#1931) feat: add GitHub team allowlist configuration option (#1694) Add in Dockerfile support for last Terraform 1.0.x version in AVAILABLE_TERRAFORM_VERSIONS (#1957) build(deps): bump github.com/spf13/viper from 1.10.0 to 1.10.1 (#1956) deps: terraform 1.1.2 (#1952) release: 0.17.6 (#1947) docker: make multi-platform atlantis image (#1943) docker(testing): fix arch ref for `linux/arm/v7` docker(testing): updating image build process docs: fix policy check documentation examples (#1945) build: make multi-platform image for testing-env atlantis-base: fix context atalntis-base: update platforms and path trigger atlantis-base: update platforms ...

m00lecule · 2022-01-03T18:26:51Z

Hello, if i might ask a question - does this feature support (or will) custom workflows? Currently I am using terragrunt as terraform wrapper

bmbferreira · 2022-01-06T09:12:52Z

Hello, Does it also work with other source control tools like bitbucket? Because I keep getting a black screen without any logs I am running v0.18.0 Thanks

I don't think it's related with bitbucket, I'm having the same issue on github with 0.18.1.

nishkrishnan · 2022-01-06T21:28:54Z

Hello, if i might ask a question - does this feature support (or will) custom workflows? Currently I am using terragrunt as terraform wrapper

Ideally yes we would want to support streaming all commands this was just the first step to get it out there.

nishkrishnan · 2022-01-06T21:29:27Z

Hello, Does it also work with other source control tools like bitbucket? Because I keep getting a black screen without any logs I am running v0.18.0 Thanks

I don't think it's related with bitbucket, I'm having the same issue on github with 0.18.1.

Can you guys create an issue for this with the details on which vcs provider you're using and any error logs?

juozasget · 2022-02-09T11:51:20Z

@nishkrishnan
This feature looks amazing! I am very much interested to see support for custom workflows as we are using terragrunt.
Is there an issue open for this to track the progress?

I would be interested to try and see If I can contribute - if possible.

Thank you very much, cheers!

fvdnabee · 2022-02-10T16:43:36Z

@juozasget I opened #2054, feel free to contribute there.

msarvar and others added 23 commits December 10, 2021 09:50

Revert "Orca 845 (#89)"

3401510

This reverts commit a9e1712.

Fixing merge

b91001e

Fixing errors

8761857

Log Streaming Bug Fix and Refactor (#101)

3c4ceaa

Removing tf show output when streaming logs (#104)

ca9b851

Adding logic to clear terminal screen when running new plan (#105)

d2c22ea

Do not display non essential tf commands (#108)

9d67480

* Do not display non essential tf commands * Add title with correct tabbing * fix ui issues * more fixes

Remove blocking call from within Rlock. (#119)

9c88cd0

Use communication channel to notify about the websocket closed (#131)

d574dcb

* So for whatever reason tf show with big plan doesn't work in async * rename isValidCommand to isAsyncEligibleCommand

increasing bufio buffer size to 10mb (#133)

bcd5a5e

Remove no-color args and strip ansi for PRs. (#136)

34323fb

Make log-streaming terminal UI full screen (#134)

0c71715

Add error checking to job url generator. (#137)

6276c72

Making terminal scrollback to 15000 (#138)

91f23a7

Support Log Streaming URLs for project without a project name (#140)

2b5fa72

Generating handler mock

b8ca55e

Create NoopProjectCommandOutputHandler to disable log streaming if TFE (

cf2812e

#144) is enabled

Aayyush requested a review from a team as a code owner December 14, 2021 18:28

Aayyush added 3 commits December 15, 2021 11:06

Fixing test

e48aba0

Fixing e2e tests

ce64ed2

Reverting test fixtures to match master

781ab37

MarkIannucci mentioned this pull request Dec 19, 2021

Ability to view the current processes and logs on the dashboard #1946

Open

pcalley reviewed Dec 22, 2021

View reviewed changes

server/controllers/websocket/writer.go Outdated Show resolved Hide resolved

chenrui333 changed the title ~~Streaming terraform logs in real-time~~ feat: streaming terraform logs in real-time Dec 22, 2021

nishkrishnan reviewed Dec 23, 2021

View reviewed changes

server/events/pull_closed_executor.go Outdated Show resolved Hide resolved

nishkrishnan approved these changes Dec 23, 2021

View reviewed changes

Aayyush and others added 5 commits December 28, 2021 13:19

Revert "Reverting test fixtures to match master"

e40b984

This reverts commit 781ab37.

Final pass

a59dd4b

Merge branch 'master' into log-streaming-upstream

b3cbc81

Fix unused variable error

670ec04

retrigger checks

009a246

nishkrishnan merged commit 004074a into runatlantis:master Dec 30, 2021

nishkrishnan deleted the log-streaming-upstream branch December 30, 2021 14:52

syphernl mentioned this pull request Jan 6, 2022

GitLab: Error when generating URL for Commit Status #1979

Closed

fvdnabee mentioned this pull request Jan 6, 2022

terraform logs streaming feature removed web authentication in atlantis 0.18 #1980

Closed

Aayyush mentioned this pull request Jan 18, 2022

fix: add back basic auth support #2008

Merged

askmike1 mentioned this pull request Jan 28, 2022

Streaming does not appear to work properly with ALB #2026

Closed

This was referenced Feb 3, 2022

Better feedback during applies #185

Closed

Post results of project plan/apply runs as they complete #2016

Closed

fvdnabee mentioned this pull request Feb 10, 2022

Terraform log streaming for custom workflows #2054

Closed

jamengual mentioned this pull request May 13, 2022

Stream Terraform output through web interface #1315

Closed

ascandella mentioned this pull request May 17, 2022

feat: stream output for custom workflows #2261

Merged

krrrr38 pushed a commit to krrrr38/atlantis that referenced this pull request Dec 16, 2022

feat: streaming terraform logs in real-time (runatlantis#1937)

5496c4a

nitrocode mentioned this pull request Jan 16, 2023

Atlantis 1.0.0 Release #2496

Open

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: streaming terraform logs in real-time #1937

feat: streaming terraform logs in real-time #1937

Aayyush commented Dec 14, 2021 •

edited

Loading

msarvar commented Dec 17, 2021

nishkrishnan left a comment

karimbouchouicha commented Dec 30, 2021 •

edited

Loading

m00lecule commented Jan 3, 2022

bmbferreira commented Jan 6, 2022

nishkrishnan commented Jan 6, 2022

nishkrishnan commented Jan 6, 2022

juozasget commented Feb 9, 2022

fvdnabee commented Feb 10, 2022

feat: streaming terraform logs in real-time #1937

feat: streaming terraform logs in real-time #1937

Conversation

Aayyush commented Dec 14, 2021 • edited Loading

How to use it?

msarvar commented Dec 17, 2021

nishkrishnan left a comment

Choose a reason for hiding this comment

karimbouchouicha commented Dec 30, 2021 • edited Loading

m00lecule commented Jan 3, 2022

bmbferreira commented Jan 6, 2022

nishkrishnan commented Jan 6, 2022

nishkrishnan commented Jan 6, 2022

juozasget commented Feb 9, 2022

fvdnabee commented Feb 10, 2022

Aayyush commented Dec 14, 2021 •

edited

Loading

karimbouchouicha commented Dec 30, 2021 •

edited

Loading