basic logging client

Author: thesandlord

README.md

@@ -1,2 +1,50 @@
-# pipetostackdriverlogs
-Simple service that will let you pipe logs directly to stackdriver logging
+# LogPipe
+Simple service that will let you pipe logs directly to [Stackdriver Logging](https://cloud.google.com/logging/).
+
+## Background
+Google App Engine and Container Engine automatically stream logs to Stackdriver Logging. [Docker](https://www.docker.com) also supports [streaming logs to Stackdriver](https://docs.docker.com/engine/admin/logging/gcplogs/).
+
+However, raw Compute Engine does not. Other cloud VMs also do not. You can install the [logging agent](https://cloud.google.com/logging/docs/agent/installation) on Compute Engine, but that requires you to log to a [common log file, custom log file, or syslog](https://cloud.google.com/logging/docs/view/service/agent-logs).
+
+If you want a simple way to stream logs from the Stdout of any program to Stackdriver Logging, this is for you!
+
+# Install
+    go get -u github.com/thesandlord/logpipe
+# Setup
+
+_Note: If you are running on Google Compute Engine, there is no need for any setup._
+
+If you want to use this on your local machine, install the [Google Cloud SDK](cloud.google.com/sdk) and run:
+
+
+    gcloud auth application-default login
+
+If you are running on a VM outside Google Cloud, follow the steps [here](https://developers.google.com/identity/protocols/application-default-credentials#howtheywork) to set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable.
+
+# Usage
+
+```
+Usage:
+  logpipe [OPTIONS]
+
+Application Options:
+  -p, --project= Google Cloud Platform Project ID
+  -l, --logname= The name of the log to write to (default: default)
+
+Help Options:
+  -h, --help     Show this help message
+```
+
+## Examples
+
+This will log all the output from a Node.js program
+
+    node app.js | logpipe -p <YOUR_PROJECT_ID>
+
+This will log the word "hello" 5 times to the "default" log
+
+    yes hello | head -n 5 | logpipe -p <YOUR_PROJECT_ID>
+
+This will log the word "test" to the "tester" log
+
+    echo test | logpipe -p <YOUR_PROJECT_ID> -l tester

circle.yml

@@ -0,0 +1,8 @@
+deployment:
+ release:
+ branch: master
+ commands:
+ — go get github.com/mitchellh/gox
+ — go get github.com/tcnksm/ghr
+ — gox -ldflags "-X main.Version $BUILD_VERSION -X main.BuildDate $BUILD_DATE" -output "dist/ncd_{{.OS}}_{{.Arch}}"
+ — ghr -t $GITHUB_TOKEN -u $CIRCLE_PROJECT_USERNAME -r $CIRCLE_PROJECT_REPONAME --replace `git describe --tags` dist/

logpipe.go

@@ -0,0 +1,83 @@
+/*
+	Copyright 2017, Google, Inc.
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+// Command logpipe is a service that will let you pipe logs directly to Stackdriver Logging.
+package main
+
+import (
+	"bufio"
+	"fmt"
+	"log"
+	"os"
+
+	flags "github.com/jessevdk/go-flags"
+
+	"cloud.google.com/go/logging"
+	"golang.org/x/net/context"
+)
+
+func main() {
+	ctx := context.Background()
+
+	var opts struct {
+		ProjectID string `short:"p" long:"project" description:"Google Cloud Platform Project ID" required:"true"`
+		LogName   string `short:"l" long:"logname" description:"The name of the log to write to" default:"default"`
+	}
+
+	flags.Parse(&opts)
+
+	projectID := &opts.ProjectID
+	logName := &opts.LogName
+
+	if *projectID == "" {
+		fmt.Printf("Please specify a project ID\n")
+		return
+	}
+
+	// Check if Standard In is coming from a pipe
+	fi, err := os.Stdin.Stat()
+	if err != nil {
+		panic(err)
+	}
+	if fi.Mode()&os.ModeNamedPipe == 0 {
+		fmt.Printf("Nothing is piped in so there is nothing to log!\n")
+		return
+	}
+
+	// Creates a client.
+	client, err := logging.NewClient(ctx, *projectID)
+	if err != nil {
+		log.Fatalf("Failed to create client: %v", err)
+	}
+
+	// Selects the log to write to.
+	logger := client.Logger(*logName)
+
+	// Read from Stdin and log it to Stdout and Stackdriver
+	scanner := bufio.NewScanner(os.Stdin)
+	for scanner.Scan() {
+		text := scanner.Text()
+		fmt.Println(text)
+		logger.Log(logging.Entry{Payload: text})
+	}
+
+	// Closes the client and flushes the buffer to the Stackdriver Logging
+	// service.
+	if err := client.Close(); err != nil {
+		log.Fatalf("Failed to close client: %v", err)
+	}
+
+	fmt.Printf("Finished logging\n")
+}