Skip to content

Commit

Permalink
Remove reference how to search the app's errors on defunct Splunk (#544)
Browse files Browse the repository at this point in the history
#### What is the purpose of this pull request?

Since we're no longer using Splunk. There's also the case that we were logging this message to users without access to the logging service, which wasn't helpful. 

#### Types of changes

* [ ] Bug fix (a non-breaking change which fixes an issue)
* [x] New feature (a non-breaking change which adds functionality)
* [ ] Breaking change (fix or feature that would cause existing functionality to change)
* [ ] Requires change to documentation, which has been updated accordingly.
  • Loading branch information
filipewl authored Sep 20, 2023
2 parents 524bbac + c94a0ba commit 566900b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 17 deletions.
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

## [6.45.22] - 2023-09-20

### Removed

- Remove reference of how to search for the app's errors on now-defunct Splunk.

### Fixed

- Error tracing spans not logging the details.
Expand Down Expand Up @@ -1793,11 +1799,12 @@ instead
- `HttpClient` now adds `'Accept-Encoding': 'gzip'` header by default.


[Unreleased]: https://github.com/vtex/node-vtex-api/compare/v6.45.21...HEAD
[Unreleased]: https://github.com/vtex/node-vtex-api/compare/v6.45.22...HEAD
[6.45.15]: https://github.com/vtex/node-vtex-api/compare/v6.45.14...v6.45.15
[6.45.14]: https://github.com/vtex/node-vtex-api/compare/v6.45.13...v6.45.14
[6.45.13]: https://github.com/vtex/node-vtex-api/compare/v6.45.12...v6.45.13

[6.45.22]: https://github.com/vtex/node-vtex-api/compare/v6.45.21...v6.45.22
[6.45.21]: https://github.com/vtex/node-vtex-api/compare/v6.45.21-beta.2...v6.45.21
[6.45.21-beta.2]: https://github.com/vtex/node-vtex-api/compare/v6.45.21-beta.1...v6.45.21-beta.2
[6.45.21-beta.1]: https://github.com/vtex/node-vtex-api/compare/v6.45.21-beta.0...v6.45.21-beta.1
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@vtex/api",
"version": "6.45.21",
"version": "6.45.22",
"description": "VTEX I/O API client",
"main": "lib/index.js",
"typings": "lib/index.d.ts",
Expand Down
15 changes: 0 additions & 15 deletions src/service/logger/logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,20 +92,5 @@ export class Logger {
}

console.log(JSON.stringify(inflatedLog))

// Warn the developer how to retrieve the error in splunk
this.logSplunkQuery()
}

/**
* Logs splunk query so the developer can search for the errors in splunk.
* This function runs only once in the lifetime of the Logger class so we
* don't mess up with the developer's terminal
*/
private logSplunkQuery = () => {
if (linked) {
const message = `Try this query at Splunk to retrieve error log: 'index=io_vtex_logs app="${app}" account=${this.account} workspace=${this.workspace} level=error OR level=warn'`
logOnceToDevConsole(message, LogLevel.Info)
}
}
}

0 comments on commit 566900b

Please sign in to comment.