Extensions

Extension in TeamCity is a point where standard TeamCity behavior can be changed. There are three marker interfaces for TeamCity extensions:

jetbrains.buildServer.serverSide.ServerExtension
jetbrains.buildServer.agent.AgentExtension
jetbrains.buildServer.TeamCityExtension

Extension interface implements one of these marker interfaces. ServerExtension and AgentExtension are used to mark server and agent side extensions correspondingly. TeamCityExtension is the base interface for ServerExtension and AgentExtension. Thus you can take a list of all available extensions in TeamCity by taking a look at interfaces which extend these marker interfaces.

Registering custom extension

There are two ways to register custom extension:

define a bean in the Spring context which implements extension interface, in this case your extension will be loaded automatically
register your extension at runtime in the jetbrains.buildServer.ExtensionHolder service (can be obtained by Spring autowiring feature)

Available extensions

Server-side extensions

Extension	Since	Description
`jetbrains.buildServer.serverSide.TextStatusBuilder`	3.0	Allows to customize text status line of the build, i.e. the build description which usually contains text like "Tests passed: 234, failed: 4 (2 new)".
`jetbrains.buildServer.serverSide.TriggeredByProcessor`	4.0	Similar to TextStatusBuilder but affects "Triggered by" value shown in the UI.
`jetbrains.buildServer.serverSide.FailedTestOutputFormatter`	4.0	This extension allows to apply custom formatting to test stacktrace to be shown in the UI.
`jetbrains.buildServer.serverSide.buildDistribution.StartBuildPrecondition`	4.5	Allows to define preconditions for build starting on an agent, that is, you can instruct TeamCity to delay build till some condition is met.
`jetbrains.buildServer.serverSide.GeneralDataCleaner`	2.0	This extension is called when cleanup process is going to finish, plugins can clean their data with help of this extension.
`jetbrains.buildServer.serverSide.DataCleaner`	2.0	This extension is called when cleanup process is going to clean up data of a build, plugins can remove their data associated with this build with help of this extension.
`jetbrains.buildServer.serverSide.ParametersPreprocessor`	3.0	Allows to modify build parameters right before they are sent to an agent.
`jetbrains.buildServer.serverSide.parameters.BuildParametersProvider`	5.0	Allows to add additional parameters available for a build. It differs from ParametersPreprocessor in a way that parameters added by BuildParametersProvider will be available in popup showing available parameters, and will be considered when requirements are calculated.
`jetbrains.buildServer.serverSide.parameters.ParameterDescriptionProvider`	5.0	Provides a human readable description for a parameter, see also BuildParametersProvider.
`jetbrains.buildServer.messages.serviceMessages.ServiceMessageTranslator`	4.0	Translator for specific type of service messages.
`jetbrains.buildServer.usageStatistics.UsageStatisticsProvider`	6.0	Provides a custom usage statistics.

Extending TeamCity: Developing TeamCity Plugins | Web UI Extensions

Last modified: 20 April 2023