CHANGES.md

Changes

[Fix] - bugfix

[Breaking] - breaking change

[Feature] - new feature

[Improvement] - non-breaking improvement

[Code] - code quality related change that shouldn't make any significant difference for end-user

[Build] - only related to ways how someone can build application

CHANGELOG

0.13.0

• [Fix] smartSummarize now supports wildcards in the metric names (thx to @Peter-Sh)
• [Fix] json format correctly distinguishes between +-inf and nan (thx to @faceair)
• [Fix] prometheus backend: fix a bunch of problems related to globs and regex escaping (thx to @rodio)

0.13.0.rc.3

• [Fix] Proper fix for prometheus backend and non-taged render requests with groupByNodes function
• [Fix] Align timestamps in prometheus backend (thx to @rodio, #467)

0.13.0-rc.2

• [Fix] Prometheus backend wasn't working correctly for non-taged render requests (#465, thx to @menai34 for proposed fix)
• [Fix] Fix panic when using prometheus tagged response for non-tagged queries in groupByTags function (and maybe more)
• [Fix] Add proper aliases for aggregate functions - that would make groupByTags properly usable with functions like diff and total.

0.13.0-rc.1

• [Improvement] Redesign error handling and logging. Logging should be now less noisy and all error messages should contain better reasoning about error cause
• [Improvement] Move some of the logging messages to Debug level - that should make logs less noisy and still preserve ability to see detailed errors on Debug level
• [Improvement] Add a config parameter to disable tldCache (useful for clickhouse-based backends)
• [Improvement] Implement noNullPoints query parameter. Works only with JSON as in graphite-web
• [Improvement] For all SeriesLists functions, allow to specify default argument (thx to kolobaev@)
• [Improvement] Add support for round function (thx to kolobaev@)
• [Improvement] Add integralByInterval function (thx to faceair@)
• [Improvement] Add sortBy function (thx to misiek08@)
• [Improvement] Add smartSummarize function (thx to misiek08@)
• [Fix] /render and /metrics/find URLs now works correctly for format=carbonapi_v2_pb (protov3) and for new format (carbonapi as a carbonapi's backend)
• [Fix] Allow '%' in metric names
• [Fix] zipper metrics now exported again
• [Fix] applyByNode - fix various incompatibilities with graphite-web (node starts with 1, some rewrite related issues, etc) (thx to faceair@)
• [Fix] Honor SendGlobAsIs and AlwaysSendGlobAsIs (important for pre-0.12 configs)
• [Fix] Fix panic in some cases when one of the metrics is missing
• [Fix] Compatbility fixes to useAboveSeries (now it's behavior matches graphite-web's)
• [Fix] Fix seriesList functions in case of unsorted responses (*seriesList sorts denomniators and numerators first of all)
• [Fix] Fix pprof endpoint routing (thx to faceair@)
• [Fix] Various fixes around error handling (thx to faceair@)
• [Fix] Avoid multiple requests for time moving based functions (thx to faceair@)
• [Code] Make linters much more happier about the code (thx to faceair@ for contribution)
• [Breaking] [Code] Comment out support for gRPC backend type. It was never properly tested and likely need complete rework before it will be usable
• [Breaking] [Build] Minimum Supported golang version is 1.13.0

0.12.6

• [Fix] Fix aliasByTags to work correclty with other functions
• [Fix] panic when using protov2 and backend that doesn't support tags (thx to @gekmihesg)

0.12.5

• [Feature] Implement 'highest' function
• [Feature] Implement 'lowest' function
• [Feature] Implement 'aggregateLine' function
• [Feature] Implement 'filterSeries' function

0.12.4

• [Feature] Function Defines - allows to do custom metric aliases (thx to @lomik). See doc/configuration.md for config format
• [Improvement] New config options that allows to prefix all URLs and to enable /debug/vars on a separate address:port. See docs/configuration.md for more information
• [Improvement] /render queries now returns tags in json (as graphite-web do)
• [Improvement] groupByTags should now support all available aggregation functions (#410)
• [Fix] Fix panic when using carbonapi_proto_v3 and doing tag-related queries (#407)
• [Fix] Add missing alias for averageSeries (thx to @msaf1980)

0.12.3

• [Fix] Fix graphiteWeb proxy function (thx. to @sylvain-beugin)
• [Fix] Prometheus Backend: correctly handle groups, fixes #405
• [Fix] Prometheus Backend: convert target that doesn't contain seriesByTags in a same way that's used for /metrics/find
• [Fix] change behavior of aliasSub to match graphite-web (fixes #290)
• [Improvement] Prometheus backend: Allow to specify "start" parameter (via backendOptions)

0.12.2

• [Fix] Fix stacked cairo-based graphs (doesn't affect json or grafana rendering)
• [Fix] Correctly deduplicate requests for cases where same metric fetched in the same expression and cache is disabled. Fixes #401
• [Fix] Make all zipper's errors non-fatal (carbonapi will try to fetch construct full response no matter what error it was)
• [Fix] Make zipper less noisy

0.12.1

• [Improvement] Port 'minValue' parameter handling for nonNegativeDerivative and perSecond: https://github.com/bookingcom/carbonapi/commit/5bfda0d24 and https://github.com/bookingcom/carbonapi/commit/790c05d8
• [Improvement] Config option "headersToPass" to control what request headers will be passed to backend (default: none). Fixes #398
• [Improvement] Config option "headersToLog" to control what request headers will be logged by carbonapi (default: none).
• [Fix] Cherry-pick https://github.com/bookingcom/carbonapi/commit/946ca8b (fixes small png render issues)
• [Fix] #260 - parsing of bool values as Names.
• [Fix] Fix limiter waiting for a wrong server in some cases
• [Code] Cherry-pick https://github.com/bookingcom/carbonapi/pull/172/commits/9f0b3f611 to simplify tests (author: @gksinghjsr)

0.12.0

• Add support for Prometheus as Backend. This allows to use Prometheus-compatible software as carbonapi's backends (e.x. Prometheus and VictoriaMetrics)
• Add support for querying msgpack-compatible backends. This should make carbonapi compatible with graphite-web 1.1 and grafana/metrictank
• [Breaking][Code] Migrate all internal structures to github.com/go-graphite/protocol/carbonapi_v3_pb. This removes redundant IsAbsent slice and changes all timestamps to int64 (they are still expected to have uint32 timestamps there)
• [Breaking][Improvement] Integrate carbonzipper 1.0.0. This introduces better loadbalancing support, but significantly changes config file format. It might behave differently with the same settings. It also removes carbonzipper dependency.
• [Improvement] seriesByTag Support (thx. to Vladimir Kolobaev)
• [Improvement] aliasByTag Support (thx. to Vladimir Kolobaev)
• [Improvement] Added support for more aggregation functions (thx. to Oleg Matrokhin)
• [Improvement] Add 'aggregate' function.
• [Improvement] pixelRatio for png render (thx. to Roman Lomonosov)
• [Fix] Supported functions were updated to be more compatible with graphtie-web 1.1.0+
• [Fix] fix movingXyz error on intervals greater than 30 days (thx. to Safronov Michail)
• [Fix] Fix timeShift function (thx. to Gunnar Þór Magnússon)

0.12.0-rc.1

• Fix panic when using Prometheus backend and query /tags/autoComplete/tags without parameters
• Fix long going issue with stuck requests towards backend.

0.12.0-rc.0

• Add experimental support for Prometheus as Backend.
• Add experimental support for querying msgpack-compatible backends. This should make carbonapi compatible with graphite-web 1.1 and grafana/metrictank
• [Breaking][Code] Migrate all internal structures to github.com/go-graphite/protocol/carbonapi_v3_pb. This removes redundant IsAbsent slice and changes all timestamps to int64 (they are still expected to have uint32 timestamps there)
• [Breaking][Improvement] Migrate to carbonzipper 1.0.0. This introduces better loadbalancing support, but significantly changes config file format. It might behave differently with the same settings.
• seriesByTag Support (thx. to Vladimir Kolobaev)
• aliasByTag Support (thx. to Vladimir Kolobaev)
• Supported functions were updated to be more compatible with graphite-web 1.1.0+
• Added support for more aggregation functions (thx. to Oleg Matrokhin)

0.11.0

• [Breaking][Fix] Allow to specify prefix for environment variables through -envprefix command line parameter. Default now is "CARBONAPI_" which might break some environments
• [Improvement] graphiteWeb function that implements force-fallback to graphiteWeb
• [Improvement] graphiteWeb can query graphite-web 1.1.0+ for a list of supported functions and automatically do fallback to graphite in case user calls unimplemented function
• [Improvement] New config switch to disable find request before render. This is helpful for graphite-clickhouse backends
• [Fix] Fix typo in polyfit function description
• [Fix] Skip metrics without pairs in reduceSeries (thx. to @errx)
• [Fix] Fix config file parsing (thx. to @errx)
• [Code] Move MakeResponse to expr/types and rename it to MakeMetricData. This is sometimes useful outside of tests. Thx. to @borovskyav
• [Code] Add helper package that will ease doing per-function tests. See expr/functions/absolute/function_test.go for an example

0.10.0.1

• [Fix] Autobuild scripts. Version bump to avoid retagging.

0.10.0

• [Fix] lineWidth param is not working
• [Fix] Support & in metric name
• [Fix] default colors for png and svg are now defined as in graphite-web in 1.1.0, but add example of how to set them to new colors
• [Improvement] You can override default colors through config
• [Improvement] It's now possible to specify 'template=' option to png or svg renders. It will use templates that's specified by 'graphTemplates' option in config. Template config format is not compatible with graphite-web though and uses either toml or yaml. Options naming is also different and follows URL override style.
• [Code] Minor API changes in expr/png: MarshalPNGRequest and MarshalSVGRequest now requires to specify template.

0.9.2

• [Improvement] "pipe" function chaining syntax. Same way as in graphite-project/graphite-web#2042 (thx. to @lomik)

0.9.1

• [Code] Refactor expr. Split it into pkg/parser. Simplify tests.
• [Code] Refactor expr. Split functions into directories.
• [Code] Simple docs about how to add a new function.
• [Fix] All aggregating functions (e.x. summarize) now adds math.NaN() to begin and end of value list to make them same size.
• [Fix] Experimental option ExtrapolateExperiment that allows aggregating functions to extrapolate data. Function is not tested properly yet and might be buggy, disabled by default
• [Improvement] API to get list of functions (graphite-web 1.1 compatibility)
• [Improvement] Add 'first' and 'last' as consolidateBy options

0.9.0

• [Improvement] Merge carbonzipper into carbonapi. Please migrate to new 'upstreams' in the config file.
• [Improvement] Make default cache timeout configurable.
• [Improvement] Add divideSeriesLists (thx. to Oleg Matrokhin)
• [Improvement] Add groupByNodes (thx to @errx)
• [Improvement] Add cumulative(thx to Oleg Matrokhin)
• [Improvement] Add diffSeriesLists and multiplySeriesLists functions (works the same way as divideSeriesLists vs divideSeries)
• [Improvement] Add linearRegression function (thx. to Oleg Matrokhin)
• [Improvement] Allow applyByNode to generate new targets
• [Improvement] Allow diffSeries to substract series with different Steps
• [Improvement] Make cache timeouts configurable
• [Improvement] Make batch size configurable for sendGlobAsIs
• [Improvement] Export GoVersion through expvars
• [Improvement] Allow overriding config variables through ENV
• [Improvement] Allow to use .toml in addition to .yaml as config file (determined by extension)
• [Improvement] Add fallbackSeries (thx to @gksinghjsr)
• [Improvement] Implement areaMode in cairo rendering (thx. to @ibuclaw)
• [Improvement] Implement lineWidth, rightWidth, leftWidth (for cairo rendering) (thx. to @ibuclaw)
• [Improvement] Add Unicode support for series names (thx. to @korservick)
• [Improvement] Add multiplySeriesWithWildcards (thx. to @kamaev)
• [Improvement] Add stddevSeries (thx. to @kamaev)
• [Improvement] Add mapSeries (thx. to @kipwoker)
• [Improvement] Add reduceSeries (thx. to @kipwoker)
• [Improvement] Add delay() function (thx. to @kipwoker)
• [Improvement] Update asPercent to graphite-web 1.1 (thx. to @kipwoker)
• [Fix] Fix rounding errors when generating yLables for Cairo-based renders (thx. to @ibuclaw)
• [Fix] Fix integer overflow when building for 32bit systems
• [Fix] Don't set path in treejson if '.' not found in name (thx. to @ibuclaw)
• [Fix] Fix derivative() if first arg is missing (thx. to Oleg Matrokhin)
• [Fix] Fix calculation of yTop when using log base (thx. to @ibuclaw)
• [Fix] Fix asPercent() to handle multiple series (thx. to @ibuclaw)
• [Fix] Swap red and darkred colors (thx to @ibuclaw)
• [Fix] Make asPercent graphite-compatible #213
• [Fix] Fix summarize for cases when bucketSize < stepTime
• [Fix] Fixed #90 - carbonapi shouldn't fail if one of the series doesn't exist
• [Fix] Make PNG rendering looks like graphite-web (thx. to @lomik)
• [Fix] Don't fail if argument is empty series (graphite-web compatibility, thx. to @gksinghjsr)
• [Fix] Fix group() function #225 (thx. to @gksinghjsr)
• [Code] Small refactor of PictureParams structs. Makes GetPictureParams and DefaultColorList public.

0.8.0

• [Breaking] Most of the configuration options moved to a config file
• [Breaking] Logging migrated to zap (structured logging). Log format changed significantly. Old command line options removed. Please consult carbonapi.example.yaml for a new config options and explanations
• [Improvement] CarbonAPI now passes extra headers to keep track of requests
• [Improvement] Allow '^' and '$' as name characters. Required for carbonsearch text-match pattern anchoring
• [Improvement] Allow to bind to arbitrary IP:Port. (thx to @zdykstra, #194), Fixes #176
• [Improvement] Extend legendValues to append multiple values
• [Improvement] Add a switch to turn off propagating globbed requests to carbonzipper (was introduced in 0.7.0)
• [Improvement] Add {find,render}_cache_overhead_ns metrics that shows cache query overhead in nanoseconds
• [Improvement] Use dep as a vendoring tool
• [Improvement] Add a Makefile that will hide some magic from user.
• [Improvement] Send glob heruistic -- if request with globs is relatively small (<100 metrics) carbonapi will send it as is.
• [Improvement] divideSeries support seriesList in dividents (#203, thx @cldellow)
• [Improvement] added movingMin/movingMax/movingSum (#206, thx @cldellow)
• [Feature] Implement following functions from graphite-web: linewidth, areaBetween, applyByNode
• [Feature] Add fft, ifft, LowPass functions. See COMPATIBILITY.md for more information
• [Feature] Publish current configuration as an expvar (GET /debug/vars)
• [Feature] Make prefix configurable (thx to @StephenPCG, #189)
• [Fix] Fix issue with missing labels on graphs > 14d
• [Fix] Allow expressions to use 'total' instead of 'sum'. Required for graphite compatibility
• [Fix] Fix incompatibility between carbonapi and older versions of carbonzipper/carbonserver/go-carbon (protobuf2-only)

Notes on upgrading:

Even though there are several changes that's marked as breaking, it only breaks local config parsing and changes logging format.

This release fixes the incompatibility introduced in 0.6.0 and can work with both new and old versions of carbonserver, carbonzipper, go-carbon

0.7.0

• [Improvement] Render requests with globs now sent as-is.
• [Improvement] Added ProxyHeaders handler to get real client's ip address from X-Real-IP or X-Forwarded-For headers.
• [Improvement] Highest* and Lowest* now assumes '1' if no second argument was passed
• [Feature] Implement legendValue expression (see http://graphite.readthedocs.io/en/latest/functions.html#graphite.render.functions.legendValue for more information)

Notes on upgrading to 0.7.0:

It's highly recommended, if you use carbonzipper to also upgrade it to version 0.62

0.6.0

• [Breaking] Migrate to protobuf3

Notes on upgrading to 0.6.0:

You need to upgrade carbonzipper or go-carbon to the version that supports protobuf3

<=0.5.0 There is no dedicated changelog for older versions of carbonapi. Please see commit log for more information about what changed for each commit.