Skip to content

CHANGELOG.md

Latest commit

 

History

History
133 lines (90 loc) · 4.19 KB

CHANGELOG.md

File metadata and controls

133 lines (90 loc) · 4.19 KB

v6.2.1

Fixes

  • Fix "IllegalArgumentException: character to be escaped is missing" when sharing logs containing windows file paths

v6.2.0

Improvements

  • Filter usernames and session tokens in uploaded logs as defined by the instance filters
  • Fix some requests hanging when their body is being read
  • Trim beginning of logs before applying limits to avoid counting leading newlines and whitespace towards the limit

Deprecations

  • The pattern constants in Log are now deprecated and only serve as fallbacks when the filters endpoint is not available on the specified instance.
  • Log#getContent(Limits) is now deprecated. The new getContent(FilterList) method is internal and might change without notice.
  • LogReader#readContents(Limits) is now deprecated. The new readContents(FilterList) method is internal and might change without notice.

v6.1.0

Improvements

  • Add listFilesInDirectory method to MclogsClient. 1

v6.0.0

Breaking Changes

  • Api methods now complete exceptionally if the server returns an error response instead of returning a response object with error details.
    • Removed ApiException#getResponse and JsonResponse#throwIfError methods.
    • Remove JsonResponse
    • Remove the success and error fields from response objects.
  • Some response classes from response.insights have been moved to response.entry.
  • Many classes have been marked as final or not-extendable.
  • LimitedReader and Util are now internal
  • LogReader has been split into multiple classes in the reader package.
  • Removed deprecated constants and constructor from the Log class.
  • Mclogs instances running v1 are no longer supported.

New Features

  • You can now specify a source and other metadata when uploading logs. By default, this is filled with the project name you can set with MclogsClient#setProjectName(String)
  • You can delete logs after uploading them using UploadLogResponse#delete() or MclogsClient#deleteLog(id, token) with the token from the upload response.
  • Uploading a log now returns many new fields
  • These new fields, the raw content, the parsed log entries and insights can now be fetched with a single request.
  • Uploaded logs are now automatically compressed with GZIP during transfer

Improvements

  • Remove exception that is never thrown from signature of MclogsClient#analyseLog(Path)
  • Add annotations for nullability where missing
  • Limits are now applied to all methods that upload logs before the upload happens
  • ApiException now includes the HTTP status code

v5.0.0

Breaking Changes

  • MclogsClient#uploadLog(Path) now throws an ExecutionException if reading the file fails instead of throwing an IOException immediately.

Improvements

  • Add endpoint for analysing a log without storing it
  • Add endpoint for fetching storage limits
  • Use instance limits for truncating logs passed by their path
  • Do not read more log content than the limit from the input stream

v4.1.1

  • Allow more BungeeCord log file names

v4.1.0

  • Add Path based variants to listCrashReportsInDirectory and listLogsInDirectory

v4.0.2

  • Fix setting client in UploadLogResponse (Fix #9)

v4.0.1

  • fix accept header name

v4.0.0

  • Update dependencies
  • Utilize CompletableFuture to wrap around API calls
  • API calls are now async
  • Moved visibility of all fields to private, some are also final
  • Utilizes Java 11s HttpClient

v3.0.1

  • Update dependencies
  • mark the client property of UploadLogResponse as transient
    • This should fix an issue with deserialization on Java 17+

v3.0.0

Breaking Changes

  • Moved gs.mclo.java -> gs.mclo.api
  • Replace static methods on MclogsAPI with Mclogs class
  • You are now required to specify a user agent or project name and version
  • To use a custom instance you now need to create an instance object with your urls
  • Errors returned by the API are now thrown as exceptions

New features

  • Fetch log insights from the API
  • Improved development ergonomics

Footnotes

  1. This is the equivalent of listLogsInDirectory and listCrashReportsInDirectory but searches in the directory itself, not a subfolder. Before 6.0, this was available as a static method of the Util class ↩