Skip to content

UPGRADING.md

Latest commit

 

History

History
59 lines (45 loc) · 4.55 KB

UPGRADING.md

File metadata and controls

59 lines (45 loc) · 4.55 KB

Upgrading to Graylog 6.2.x

Breaking Changes

Plugins

  • This release includes Java API changes which might require plugin authors to adjust their code. Please check Java API Changes for details.
  • Adjustment of enterpriseWidgets web interface plugin. The editComponent attribute now no longer has a onSubmit prop. Before this change the prop had to be called to close the widget edit mode. Now it is enough to call applyAllWidgetChanges from the WidgetEditApplyAllChangesContext. Alternatively the SaveOrCancelButtons component can be used in the edit component for custom widgets. It renders a cancel and submit button and calls applyAllWidgetChanges on submit.

Configuration File Changes

Option Action Description
tbd added

Default Configuration Changes

  • tbd

Java API Changes

Upgraded MongoJack to version 5.x. This impacts the Java API for accessing documents in MongoDB. Some previously deprecated MongoJack classes (like org.mongojack.DBQuery) have been removed. Plugin authors will have to replace usages of removed classes to corresponding classes from the MongoDB driver packages, most prominently com.mongodb.client.model.Filters.

Additionally, the following Java Code API changes are included in this release:

File/method Description
org.graylog.scheduler.JobSchedule#toDBUpdate removed
org.graylog.scheduler.DBJobTriggerService#all replaced by streamAll
org.graylog.scheduler.DBJobTriggerService#getAllForJob replaced by streamAllForJob
org.graylog.scheduler.DBJobTriggerService#findByQuery replaced by streamByQuery
org.graylog.events.processor.DBEventDefinitionService#getByNotificationId replaced by streamByNotificationId
org.graylog.events.processor.DBEventDefinitionService#getSystemEventDefinitions replaced by streamSystemEventDefinitions
org.graylog.events.processor.DBEventDefinitionService#getByArrayValue replaced by streamByArrayValue
org.graylog2.lookup.db.DBCacheService#findByIds replaced by streamByIds
org.graylog2.lookup.db.DBCacheService#findAll replaced by streamAll
org.graylog2.lookup.db.DBDataAdapterService#findByIds replaced by streamByIds
org.graylog2.lookup.db.DBDataAdapterService#findAll replaced by streamAll
org.graylog2.lookup.db.DBLookupTableService#findByCacheIds replaced by streamByCacheIds
org.graylog2.lookup.db.DBLookupTableService#findByDataAdapterIds replaced by streamByDataAdapterIds
org.graylog2.lookup.db.DBLookupTableService#findAll replaced by streamAll

DBService classes' new streaming methods require streams to be closed after using - recommend using try-with-resource statements.

REST API Endpoint Changes

The following REST API changes have been made.

Endpoint Description
GET /plugins/org.graylog.integrations/aws/inputs/available_services Remove unused endpoint.
GET /plugins/org.graylog.integrations/aws/inputs/permissions Removed permissions endpoint in favor of maintaining permissions in official docs site.
/plugins/org.graylog.plugins.files/* Removed (Graylog Enterprise plugin).