Search Syntax
After you have installed and started running TeamCity, it collects the information on builds, tests and so on and indexes it. You can search builds by build number, tag, build configuration name, and other different parameters specifying one or several keywords. You can also search for builds by text in build logs, and by the external ID of a build configuration.
By default, TeamCity stores a search index locally, but you can switch to the Elasticsearch mode so the index is stored on your Elastic host. Both modes support the Lucene syntax described in this article.
Search Query
In TeamCity you can search for builds using the Lucene query syntax. Note that there is a major difference with the default Lucene syntax: by default, TeamCity uses the "prefix search" — not the exact matching like Lucene. For example, if you search for c:main, TeamCity will find all builds of the build configuration whose name starts with the main string.
As Lucene, TeamCity uses the OR operator in a query by default: if there is no Boolean operator between the two terms, OR will be used. The OR operator links two terms and finds a matching entry if either of these terms exist in it.
To narrow your search and get more precise results, use the available search fields — indexed parameters of each build. For complete list of available search fields (keywords), refer to the related section.
Performing Fuzzy Search
You also have a possibility to perform fuzzy search using the tilde (~) symbol at the end of a single word term to search for items with similar spelling.
Boolean Operators and Wildcards Support
You can combine multiple terms with Boolean operators to create more complex search queries. TeamCity Search supports the OR, NOT, and - operators. The AND operator only works in the scope of the same field (for example, tags:EAP AND tags:Production).
When using Boolean operators, type them ALL CAPS.
ORoperator helps fetch the search terms that contain either of the terms you specify in the search field. This operator is used by default.NOT(same as-in front of a query word). Exclude a word or phrase from search results.
TeamCity also supports the * and ? wildcards in a query. It is not recommended using the asterisk (*) at the beginning of the search term as it may require a significant amount of time for TeamCity to search its database. For example, the *onfiguration search term is incorrect.
Complete List of Available Search Fields, Shortcuts, and Keywords
Search Fields
When using search keywords, use the following query syntax:
Search Field | Shortcut | Description | Example |
|---|---|---|---|
agent | Find all builds that were run on the specified agent. |
| |
build | Find all builds that include changes with the specified string. |
| |
buildLog | Find all builds that include certain text in build logs. It is disabled by default. |
| |
changes | Find all builds that include changes with the specified string. |
| |
committers | Find all build that include changes committed by the specified developer. |
| |
configuration | c | Find all builds from the specified build configuration. |
|
labels | l | Find all builds that include changes with the specified VCS label. |
|
pin_comment | Find all builds that were pinned and have the specified word (string) in the pin comment. |
| |
project | p | Find all builds from the specified project. |
|
revision | Find all builds that include changes with the specified revision (for example, you can search for builds with a specific changelist from Perforce, or revision number in Subversion). |
| |
stamp | Find all builds that started at the specified time (search by timestamp). |
| |
status | Find all builds with the specified text in the build status text. |
| |
tags | t | Find all builds with the specified tag. |
|
tests | Find all builds that include specified tests. |
| |
triggerer | Find all builds that were triggered by the specified user. |
| |
vcs | Find builds that have the specified VCS. |
| |
build problem | Find builds with the specified build problem |
| |
debug | Enables showing the hit score (relevance) of each search result. Helps to diagnose problems with Builds Search. |
| |
hitscore | Hides the results with hitsocre (relevance) lower than the specified value. Hit scores of the results can be seen after adding the |
|
Shortcuts
In addition to above mentioned search fields, you can the following shortcuts in your query:
Shortcut | Description | Example |
|---|---|---|
| Search for the specified build number. |
|
| Find all builds that were run on the specified agent. |
|
Using Double-Colon
You can use the double-colon sign (::) to search for a project and/or build configuration by name:
pro::best— search for builds of configurations with the names starting withbest, and in the projects with the names starting withpro.mega::— search for builds in all projects with names starting withmega.::super— search for builds of build configurations with names starting with "super".
"Magic" Keywords
TeamCity also provides "magic" keywords (see table below for the complete list). These magic keywords are formed with the $ sign and a word itself. The word can be shortened up to one (first) syllable, that is, the $labeled, $l, and $lab keywords will be equal in a query. For example, to search for pinned builds of the "Nightly build" configuration in the "Mega" project you can use any of the following queries:
configuration:nightly project:Mega $pinnedc:nigh p:mega $pinM::night $pin
Magic word | Description |
|---|---|
| Search for builds with tags. For example, |
| Search for pinned builds. |
| Search for builds that have been labels in VCS. For example, to find labeled builds of the Main project you can use following queries: |
| Search for builds that have been commented. |
| Search for personal builds. For example, using |
Search by Build Log
By default, TeamCity does not search build logs for the entered string. To enable this feature, do the following:
Increase the server memory by at least 5 GB in the
-XmxJVM option (more if you have large build logs or many builds).Set the
tc.search.indexBuildLog=trueTeamCity internal property.Reset the search index.
After reindexing, TeamCity will be able to search for text within build logs and display the relevant builds.
Resetting Search Index
The search uses an "index" cached on the disk. Only the data previously added to the index is searchable and appears in the search results. Typically, data updates (such as new builds) cause only incremental updates to the index. This means that when some indexing setting is changed and the cached index on the disk gets out of sync, the index needs to be reset to reindex all the builds anew.
To reset the cached search index, click reset for the "search" entry on the Administration | Server Administration | Diagnostics, Caches tab or manually delete files from \< TeamCity Data Directory \>\system\caches\search while the server is not running. After that, reindexing will start which is a resource-intensive operation on the server and can take hours (depending on the number and "size" of builds, as well as the server machine and database performance). You can monitor the progress in the UI on the Search page or in the server logs.