Skip to content

Commit

Permalink
Change default rollover conditions to 2 days (#1963)
Browse files Browse the repository at this point in the history 
* Change default rollover conditions to 2 days

Signed-off-by: Pavol Loffay <ploffay@redhat.com>

* Add changelog

Signed-off-by: Pavol Loffay <ploffay@redhat.com>

* Change changelog style

Signed-off-by: Pavol Loffay <ploffay@redhat.com>

* Use the same header size

Signed-off-by: Pavol Loffay <ploffay@redhat.com>

* Change back the headings size

Signed-off-by: Pavol Loffay <ploffay@redhat.com>

* Changelog style

Signed-off-by: Pavol Loffay <ploffay@redhat.com>

* style

Signed-off-by: Pavol Loffay <ploffay@redhat.com>
  • Loading branch information
@pavolloffay @yurishkuro
pavolloffay authored and yurishkuro committed Dec 10, 2019
1 parent 39d92c9 commit 58d3f5c
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 56 deletions.
111 changes: 57 additions & 54 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,63 +4,59 @@ Changes by Version
1.16.0 (unreleased)
------------------

### Breaking Changes

#### List of service operations can be classified by span kinds

([PR #1943](https://github.com/jaegertracing/jaeger/pull/1943), [@guo0693](https://github.com/guo0693))

TODO: fix formatting/indentation below
### Backend Changes

* Endpoint changes:
* Both Http & gRPC servers now take new optional parameter `spanKind` in addition to `service`. When spanKind
is absent or empty, operations from all kinds of spans will be returned.
* Instead of returning a list of string, both Http & gRPC servers return a list of operation struct. Please
update your client code to process the new response. Example response:
```
curl 'http://localhost:6686/api/operations?service=UserService&spanKind=server' | jq
#### Breaking Changes

##### List of service operations can be classified by span kinds ([#1943](https://github.com/jaegertracing/jaeger/pull/1943), [@guo0693](https://github.com/guo0693))

* Endpoint changes:
* Both Http & gRPC servers now take new optional parameter `spanKind` in addition to `service`. When spanKind
is absent or empty, operations from all kinds of spans will be returned.
* Instead of returning a list of string, both Http & gRPC servers return a list of operation struct. Please
update your client code to process the new response. Example response:
```
curl 'http://localhost:6686/api/operations?service=UserService&spanKind=server' | jq
{
"data": [{
"name": "UserService::getExtendedUser",
"spanKind": "server"
},
{
"data": [{
"name": "UserService::getExtendedUser",
"spanKind": "server"
},
{
"name": "UserService::getUserProfile",
"spanKind": "server"
}],
"total": 2,
"limit": 0,
"offset": 0,
"errors": null
}
"name": "UserService::getUserProfile",
"spanKind": "server"
}],
"total": 2,
"limit": 0,
"offset": 0,
"errors": null
}
```
* The legacy http endpoint stay untouched:
```
/services/{%s}/operations
```
* Storage plugin changes:
* Memory updated to support spanKind on write & read, no migration is required.
* [Badger](https://github.com/jaegertracing/jaeger/issues/1922) & [ElasticSearch](https://github.com/jaegertracing/jaeger/issues/1923)
to be implemented:
For now `spanKind` will be set as empty string during read & write, only `name` will be valid operation name.
* Cassandra updated to support spanKind on write & read ([#1937](https://github.com/jaegertracing/jaeger/pull/1937), [@guo0693](https://github.com/guo0693)):
If you don't run the migration script, nothing will break, the system will used the old table
`operation_names` and set empty `spanKind` in the response.
Steps to get the updated functionality:
1. You will need to run below command on the host you can use `cqlsh` to connect the the cassandra contact
point
```
* The legacy http endpoint stay untouched:
KEYSPACE=jaeger_v1 CQL_CMD='cqlsh host 9042 -u test_user -p test_password --request-timeout=3000'
bash ./v002tov003.sh
```
/services/{%s}/operations
```
* Storage plugin changes:
* Memory updated to support spanKind on write & read, no migration is required.
* [Badger](https://github.com/jaegertracing/jaeger/issues/1922) & [ElasticSearch](https://github.com/jaegertracing/jaeger/issues/1923)
to be implemented:
For now `spanKind` will be set as empty string during read & write, only `name` will be valid operation name.
* Cassandra updated to support spanKind on write & read ([#1937](https://github.com/jaegertracing/jaeger/pull/1937), [@guo0693](https://github.com/guo0693)):
If you don't run the migration script, nothing will break, the system will used the old table
`operation_names` and set empty `spanKind` in the response.
Steps to get the updated functionality:
1. You will need to run below command on the host you can use `cqlsh` to connect the the cassandra contact
point
```
KEYSPACE=jaeger_v1 CQL_CMD='cqlsh host 9042 -u test_user -p test_password --request-timeout=3000'
bash ./v002tov003.sh
```
The script will create new table `operation_names_v2` and migrate data from the old table.
`spanKind` column will be empty for those data.
At the end, it will ask you whether you want to drop the old table or not.
2. Restart ingester & query services so that they begin to use the new table

#### Trace and Span IDs are always padded to 32 or 16 hex characters with leading zeros

([PR #1956](https://github.com/jaegertracing/jaeger/pull/1956), [@yurishkuro](https://github.com/yurishkuro))
The script will create new table `operation_names_v2` and migrate data from the old table.
`spanKind` column will be empty for those data.
At the end, it will ask you whether you want to drop the old table or not.
2. Restart ingester & query services so that they begin to use the new table
##### Trace and Span IDs are always padded to 32 or 16 hex characters with leading zeros ([#1956](https://github.com/jaegertracing/jaeger/pull/1956), [@yurishkuro](https://github.com/yurishkuro))
Previously, Jaeger backend always rendered trace and span IDs as the shortest possible hex string, e.g. an ID
with numeric value 255 would be rendered as a string `ff`. This change makes the IDs to always render as 16 or 32
Expand All @@ -83,7 +79,14 @@ Overall, the change is backward compatible:
However, some custom integration that rely on exact string matches of trace IDs may be broken.
### Backend Changes
##### Change default rollover conditions to 2 days ([#1963](https://github.com/jaegertracing/jaeger/pull/1963), [@pavolloffay](https://github.com/pavolloffay))
Change default rollover conditions from 7 days to 2 days.
Given that by default Jaeger uses daily indices and some organizations do not keep data longer than 7 days
the default of 7 days seems unreasonable - it might result in a too big index and
running curator would immediately remove the old index.
#### New Features
Expand Down
4 changes: 2 additions & 2 deletions plugin/storage/es/esRollover.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@


ARCHIVE_INDEX = 'jaeger-span-archive'
ROLLBACK_CONDITIONS = '{"max_age": "7d"}'
ROLLBACK_CONDITIONS = '{"max_age": "2d"}'
UNIT = 'days'
UNIT_COUNT = 7
UNIT_COUNT = 2
SHARDS = 5
REPLICAS = 1

Expand Down

0 comments on commit 58d3f5c

Please sign in to comment.