explaingit

yaegor/teamcity-plugin-buildeventssample

Analysis updated 2026-07-10 · repo last pushed 2017-02-15

JavaAudience · ops devopsComplexity · 2/5DormantSetup · moderate

TLDR

A sample TeamCity plugin that logs every build completion event to a dedicated file, making it easy to track build history without searching through noisy system logs.

Mindmap

mindmap
  root((repo))
    What it does
      Logs build completions
      Writes to dedicated file
      Simple event listener
    Tech stack
      Java
      Maven
      TeamCity server
    Use cases
      Track daily builds
      Troubleshoot unexpected finishes
      Learn plugin development
    Audience
      TeamCity admins
      Development leads
      Plugin developers
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Keep a clean daily record of which builds completed and when.

USE CASE 2

Troubleshoot why certain builds finish unexpectedly by reviewing the event log.

USE CASE 3

Learn how to write a custom TeamCity plugin by studying the sample code.

What is it built with?

JavaMavenTeamCity

How does it compare?

yaegor/teamcity-plugin-buildeventssampleasutosh936/job-finder-appasutosh936/spring-boot
Stars0
LanguageJavaJavaJava
Last pushed2017-02-152016-07-02
MaintenanceDormantDormant
Setup difficultymoderatemoderatemoderate
Complexity2/52/53/5
Audienceops devopsdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Requires a running TeamCity server to install the plugin, plus Maven to build the zip package.

No license information is provided in the repository, so usage terms are unclear.

In plain English

This is a sample plugin for TeamCity, which is software that development teams use to automatically build, test, and release code. The plugin's single job is to keep a record of when builds finish. It writes these events into a dedicated log file so that someone can easily look back and see exactly what happened and when. In practice, the plugin acts as a simple listener that watches the server's activity. Whenever a build completes, it captures that moment and writes it to a specific file called teamcity-buildEvents.log. To get it working, an administrator places the plugin into a special folder on the server, restarts, and then turns on a matching logging preset in the administration panel. After that, the custom log file appears and starts collecting data. This tool is really aimed at people who already manage a TeamCity server and want a straightforward way to track build completions without digging through the system's main, often noisy, logs. A development lead, for example, might use it to keep a clean record of daily build activity or to troubleshoot why certain processes might be finishing unexpectedly. Because it is described as a "sample," it is likely most useful as a learning resource for someone who wants to understand how to write their own TeamCity plugins. The project is written in Java and uses Maven, a common tool for organizing and packaging code. The build process produces a zip file that you drop into the server, which is a fairly standard approach for this kind of extension. The README is sparse on deeper technical details, keeping the explanation limited to the basic steps of building, installing, and reading the resulting logs.

Copy-paste prompts

Prompt 1
I want to create a TeamCity plugin that listens for build completion events and writes them to a custom log file. Show me how to structure the Java project with Maven and what TeamCity APIs to use, based on the teamcity-plugin-buildeventssample pattern.
Prompt 2
Help me modify the buildEvents sample plugin so that instead of just logging the build finish time, it also records the build status success or failure and the triggering user.
Prompt 3
I have a TeamCity server running. Walk me through packaging this sample plugin with Maven and installing the resulting zip into the correct server directory.

Frequently asked questions

What is teamcity-plugin-buildeventssample?

A sample TeamCity plugin that logs every build completion event to a dedicated file, making it easy to track build history without searching through noisy system logs.

What language is teamcity-plugin-buildeventssample written in?

Mainly Java. The stack also includes Java, Maven, TeamCity.

Is teamcity-plugin-buildeventssample actively maintained?

Dormant — no commits in 2+ years (last push 2017-02-15).

What license does teamcity-plugin-buildeventssample use?

No license information is provided in the repository, so usage terms are unclear.

How hard is teamcity-plugin-buildeventssample to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is teamcity-plugin-buildeventssample for?

Mainly ops devops.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.