Giter Club home page Giter Club logo

cflogger's Introduction

CFLOGGER

What is cflogger?


cflogger CloudFormation streaming logger for stack events. It logs single stack events in given time. Not gives all events history. Suitable for tracking stack build processes in ci/cd pipelines.

Here's a cflogger demo: cflogger demo GIF

Examples

Warning You must set AWS region. Otherwise you get error.


# Follows a single stack events occurring after the specified time (UTC+0).
$ cflogger --stack-name test --since "2022-12-15 15:00"  --region eu-central-1

# Follows events from the time it was run until events finish.
$ cflogger --stack-name test --region eu-central-1

# Select stack id. 
$ cflogger --stack-name "arn:aws:cloudformation:eu-central-1:890724537041:stack/test/1448c0d9-7173-114d-af33-0ac9xyzd9fb36" --region eu-central-1

# Get stack-id from aws cloudformation command output and follow stream.
$ aws cloudformation update-stack --stack-name test --template-body file:///Users/omer/sample-template.yml  | cflogger --region eu-central-1 --stack-name -

# Define timeout in minutes for cflogger.
$ cflogger --stack-name test --timeout 20 --region eu-central-1

Configuring Credentials


When using the cflogger you'll need your AWS credentials to authenticate with AWS services. cflogger supports multiple methods of supporting these credentials.

Environment Credentials - Set of environment variables that are useful when sub processes are created for specific roles.

Shared Credentials file (~/.aws/credentials) - This file stores your credentials based on a profile name and is useful for local development.

Installation


# Clone repository and go directory
$ git clone https://github.com/omerurhan/cflogger.git
$ cd cflogger

# Set OS, ARCH environment variables for build. 
# Example linux, amd64.
export OS=linux
export ARCH=amd64


# Build the binary according to your operating system.
$ make all

# Copy convenient location and run. 
$ cp -a target/cflogger /usr/local/bin 

cflogger's People

Contributors

omerurhan avatar

Stargazers

Furkan YAKTU avatar  avatar Furkan Karabulut avatar Himmet AYDOS avatar  avatar Deniz Demirci avatar

Watchers

 avatar

Forkers

yunustiras

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.