Add stackdriver project sink support #432

selmanj · 2017-09-13T23:24:04Z

This adds support for management of Stackdriver Logging sinks. The use case is to setup logging exports to buckets, pubsub topics or bigtable datasets.

See the example in the logging_project_sink.html.markdown file for an example of using terraform to manage logging a VM.

Adding followup support for logging folders, organizations, billingAccounts etc should be easier once this initial sink is checked in.

Documentation: https://cloud.google.com/logging/docs/api/tasks/exporting-logs

rosbo · 2017-09-13T23:39:43Z

website/docs/r/logging_project_sink.html.markdown

+
+# google\_logging\_project\_sink
+
+Manages a project-level logging sink.. For more information see


Oops, fixed

rosbo · 2017-09-13T23:50:51Z

google/resource_logging_project_sink.go

+		Name:        d.Get("name").(string),
+		Destination: d.Get("destination").(string),
+	}
+	if v, ok := d.GetOk("filter"); ok {


Do you need this if block? d.Get("filter") will return "" and should work without this extra if block

That's easier to read. Fixed.

rosbo · 2017-09-13T23:54:05Z

google/logging_utils.go

+// LoggingSinkId represents the parts that make up the canonical id used within terraform for a logging resource.
+type LoggingSinkId struct {
+	typ     string
+	typName string


In the docs, the parent parameter documentation says:

The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"

Instead of type, we could use resource.

resourceType instead of typ
resourceId instead of typName

Your names are much better! Fixed.

rosbo · 2017-09-13T23:59:40Z

Very good. Just some minor typos and suggestions.

danawillow · 2017-09-14T03:39:10Z

google/resource_logging_project_sink.go

+	config := meta.(*Config)
+
+	sink, err := config.clientLogging.Projects.Sinks.Get(d.Id()).Do()
+	if err != nil {


What about 404 handling? (https://github.com/terraform-providers/terraform-provider-google/blob/master/google/utils.go#L229)

Good catch; added

danawillow · 2017-09-14T04:02:39Z

google/resource_logging_project_sink_test.go

+	return nil
+}
+
+func testAccCheckLoggingProjectSinkExists(n string, sink *logging.LogSink) resource.TestCheckFunc {


Since everything this function does is also in the next one, is it worth it to keep them separate?

I kept them separate for now since testAccCheckLoggingProjectSinkExists assigns the found api object to a provided *logging.LogSink parameter and testAccCheckLoggingProjectSink checks the remote object against the locally stored attributes

However, since they both look up the api object I changed testAccCheckLoggingProjectSink to take an api object as the first parameter; now it does less duplicate work

danawillow · 2017-09-14T04:03:53Z

google/resource_logging_project_sink_test.go

+}
+
+func testAccLoggingProjectSink_basic(name, bucketName string) string {
+	return fmt.Sprintf(`resource "google_logging_project_sink" "basic" {


can you put a line break after the `? (makes it easier to see what's going on and copy and paste too) (here and elsewhere)

danawillow · 2017-09-14T04:04:27Z

google/resource_logging_project_sink_test.go

+
+resource "google_storage_bucket" "log-bucket" {
+	name     = "%s"
+}`, name, getTestProjectFromEnv(), bucketName)


likewise, line break before the `

danawillow · 2017-09-14T04:10:13Z

google/resource_logging_project_sink_test.go

+	})
+}
+
+func TestAccLoggingProjectSink_updateUniqueWriter(t *testing.T) {


Isn't this updating the bucket (/ the destination), not the unique writer?

Yeah, it is. The test is poorly named. I changed it to '_updatePreservesUniqueWriter' (as that's explicitly tested)

danawillow · 2017-09-14T04:12:29Z

website/docs/r/logging_project_sink.html.markdown

+resource "google_logging_project_sink" "my-sink" {
+    name = "my-pubsub-instance-sink"
+
+    // Can export to pubsub, cloud storage, or bigtable


https://www.terraform.io/docs/configuration/syntax.html

Single line comments start with #

Hah apparently it also accepts // as i've been using them in my hcl unknowingly for a while!

Changed to #

* Vendor cloud logging api * Add logging sink support * Remove typo * Set Filter simpler * Rename typ, typName to resourceType, resourceId * Handle notFoundError * Use # instead of // for hcl comments * Cleanup test code * Change testAccCheckLoggingProjectSink to take a provided api object * Fix whitespace change after merge conflict

@drebes

…#432)  /cc @drebes

ghost · 2020-03-31T13:52:20Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 hashibot-feedback@hashicorp.com. Thanks!

selmanj requested review from danawillow and rosbo September 13, 2017 23:24

selmanj added the new-resource label Sep 13, 2017

rosbo suggested changes Sep 13, 2017

View reviewed changes

rosbo approved these changes Sep 14, 2017

View reviewed changes

danawillow reviewed Sep 14, 2017

View reviewed changes

selmanj requested a review from danawillow September 14, 2017 17:51

danawillow approved these changes Sep 15, 2017

View reviewed changes

selmanj added 10 commits September 14, 2017 19:11

Vendor cloud logging api

8eb815e

Add logging sink support

d7e6692

Remove typo

f23faa6

Set Filter simpler

9d80ac7

Rename typ, typName to resourceType, resourceId

0174e52

Handle notFoundError

1855556

Use # instead of // for hcl comments

6f60558

Cleanup test code

7afb85d

Change testAccCheckLoggingProjectSink to take a provided api object

b8e9c7e

Fix whitespace change after merge conflict

41415ec

selmanj force-pushed the add_stackdriver_project_sink branch from 4a15dd2 to 41415ec Compare September 15, 2017 02:14

selmanj merged commit 3d5eccc into hashicorp:master Sep 15, 2017

danawillow mentioned this pull request Sep 26, 2017

Feature request: support for logging sinks #368

Closed

luis-silva pushed a commit to luis-silva/terraform-provider-google that referenced this pull request May 21, 2019

Generate Pubsub Topics/Subscriptions with MM (+add labels) (hashicorp…

32fd02d

…#432)  /cc @drebes

ghost locked and limited conversation to collaborators Mar 31, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add stackdriver project sink support #432

Add stackdriver project sink support #432

selmanj commented Sep 13, 2017

rosbo Sep 13, 2017

selmanj Sep 14, 2017

rosbo Sep 13, 2017

selmanj Sep 14, 2017

rosbo Sep 13, 2017

selmanj Sep 14, 2017

rosbo commented Sep 13, 2017

danawillow Sep 14, 2017

selmanj Sep 14, 2017

danawillow Sep 14, 2017

selmanj Sep 14, 2017

danawillow Sep 14, 2017

selmanj Sep 14, 2017

danawillow Sep 14, 2017

selmanj Sep 14, 2017

danawillow Sep 14, 2017

selmanj Sep 14, 2017

danawillow Sep 14, 2017

selmanj Sep 14, 2017

ghost commented Mar 31, 2020


		# google\_logging\_project\_sink

		Manages a project-level logging sink.. For more information see

Add stackdriver project sink support #432

Add stackdriver project sink support #432

Conversation

selmanj commented Sep 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rosbo commented Sep 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Mar 31, 2020