Forge Home

glogging

A Puppet module to manage Google Stackdriver Logging Agent

45,854 downloads

18,194 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.1.3 (latest)
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Mar 5th 2019
This version is compatible with:
  • , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'google-glogging', '0.1.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add google-glogging
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install google-glogging --version 0.1.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

google/glogging — version 0.1.3 Mar 5th 2019

Google Stackdriver Logging Puppet Module

Overview

This module will install the Google Stackdriver Logging Agent. This application is required for using Stackdriver Monitoring with a VM.

The Monitoring agent is a collectd-based daemon that gathers system and application metrics from virtual machine instances and sends them to Stackdriver Monitoring. By default, the Monitoring agent collects disk, CPU, network, and process metrics.

Setup

To install this module on your Puppet Master (or Puppet Client/Agent), use the Puppet module installer:

puppet module install google-glogging

Optionally you can install support to all Google Cloud Platform products at once by installing our "bundle" [google-cloud][bundle-forge] module:

puppet module install google-cloud

Usage

To install the Google Stackdriver Logging Agent, add the following class to your Puppet manifest.

include glogging::agent

Permissions Required

Each GCP machine requires the https://www.googleapis.com/auth/logging.write scope in order to write logs.

Using the gcompute_instance resource, you can add the following:

gcompute_instance { 'my-vm':
  ...
  service_accounts   => {
    ...
    scopes => [
        ...
        # Enable Stackdriver Logging API access
        'https://www.googleapis.com/auth/logging.write',
        ...
    ],
  }
}

For more information on how to use the gcompute_instance please visit the google-gcompute module documentation.

Viewing Logs

Please go to the Google Cloud console to view the Stackdriver logs.