https://github.com/mdb/intercom

A small logging package for use in Golang-based Concourse resource type implementations
https://github.com/mdb/intercom

concourse concourse-ci concourse-resource

Last synced: 11 months ago
JSON representation

A small logging package for use in Golang-based Concourse resource type implementations

• Host: GitHub
• URL: https://github.com/mdb/intercom
• Owner: mdb
• Created: 2020-04-18T14:38:38.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-01-31T21:40:03.000Z (over 5 years ago)
• Last Synced: 2025-06-30T16:51:20.673Z (11 months ago)
• Topics: concourse, concourse-ci, concourse-resource
• Language: Go
• Size: 78.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
![](https://github.com/mdb/intercom/workflows/CI/badge.svg)

# intercom

A small logging package for use in Golang-based [Concourse resource type implementations](https://concourse-ci.org/implementing-resource-types.html).

Because Concourse resources communicate with Concourse over stdout, it's [recommended](https://concourse-ci.org/implementing-resource-types.html) that:

> Resources can emit logs to the user by writing to stderr. ANSI escape codes (coloring, cursor movement, etc.) will be interpreted properly by the web UI, so you should make your output pretty.

`intercom` does just this and writes to stderr:

![Example Get](intercom_example.png)

## Usage Example

```golang

logger := intercom.NewLogger("debug")

// prints red text

logger.Errorf("foo")

// prints yellow text

logger.Warnf("bar")

// prints green text

logger.Infof("baz")

// prints blue text

logger.Debugf("bim")

```

All methods ultimately use `Fprintf`, so you can also do things like...

```golang

// prints 'foo bar' in red text

logger.Errorf("foo %s", "bar")

```

## Exposing log level configuration to users

By using `intercom` as a configurable logger, Concourse [resource authors](https://concourse-ci.org/implementing-resource-types.html) can expose log level configuration options to users, in effect giving resource users troubleshooting capabilities via a configurable `source` field:

```yaml

resource_types:

- name: some-resource

  type: docker-image

  source:

    repository: owner/some-resource

resources:

- name: some-resource

  type: some-resource

  source:

    log_level: debug

```