Skip to content

Commit e343ab9

Browse files
richardelmsrichardelms
authored
missing metadata accessors (#246)
1 parent c1a713c commit e343ab9

19 files changed

Lines changed: 58 additions & 58 deletions

File tree

‎bugsnag/src/main/java/com/bugsnag/BugsnagAppender.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ protected void append(final ILoggingEvent event) {
137137
public boolean onError(Report report) {
138138

139139
// Add some data from the logging event
140-
report.addToTab("Log event data",
140+
report.addMetadata("Log event data",
141141
"Message", event.getFormattedMessage());
142-
report.addToTab("Log event data",
142+
report.addMetadata("Log event data",
143143
"Logger name", event.getLoggerName());
144144

145145
// Add details from the logging context to the event
@@ -171,7 +171,7 @@ private void populateContextData(Report report, ILoggingEvent event) {
171171
// Loop through all the keys and put them in the correct tabs
172172

173173
for (Map.Entry<String, String> entry : propertyMap.entrySet()) {
174-
report.addToTab("Context", entry.getKey(), entry.getValue());
174+
report.addMetadata("Context", entry.getKey(), entry.getValue());
175175
}
176176
}
177177
}
@@ -279,7 +279,7 @@ public boolean onError(Report report) {
279279
for (LogbackMetadata metadata : globalMetadata) {
280280
for (LogbackMetadataTab tab : metadata.getTabs()) {
281281
for (LogbackMetadataKey key : tab.getKeys()) {
282-
report.addToTab(tab.getName(),
282+
report.addMetadata(tab.getName(),
283283
key.getName(),
284284
key.getValue());
285285
}

‎bugsnag/src/main/java/com/bugsnag/Report.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ public String getExceptionMessage() {
189189
* @param value the metadata value to add
190190
* @return the modified report
191191
*/
192-
public Report addToTab(String tabName, String key, Object value) {
192+
public Report addMetadata(String tabName, String key, Object value) {
193193
diagnostics.metadata.addMetadata(tabName, key, value);
194194
return this;
195195
}
@@ -211,7 +211,7 @@ public Report clearTab(String tabName) {
211211
* @param key the key of app info to add
212212
* @param value the value of app info to add
213213
* @return the modified report
214-
* @deprecated use {@link #addToTab(String, String, Object)} instead
214+
* @deprecated use {@link #addMetadata(String, String, Object)} instead
215215
*/
216216
@Deprecated
217217
public Report setAppInfo(String key, Object value) {
@@ -256,7 +256,7 @@ public Report setContext(String context) {
256256
* @param key the key of device info to add
257257
* @param value the value of device info to add
258258
* @return the modified report
259-
* @deprecated use {@link #addToTab(String, String, Object)} instead
259+
* @deprecated use {@link #addMetadata(String, String, Object)} instead
260260
*/
261261
@Deprecated
262262
public Report setDeviceInfo(String key, Object value) {

‎bugsnag/src/main/java/com/bugsnag/callbacks/DeviceCallback.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ public void run() {
8686
@Override
8787
public boolean onError(Report report) {
8888
report
89-
.addToTab("device", "osArch", System.getProperty("os.arch"))
90-
.addToTab("device", "locale", Locale.getDefault())
89+
.addMetadata("device", "osArch", System.getProperty("os.arch"))
90+
.addMetadata("device", "locale", Locale.getDefault())
9191
.setDeviceInfo("hostname", getHostnameValue())
9292
.setDeviceInfo("osName", System.getProperty("os.name"))
9393
.setDeviceInfo("osVersion", System.getProperty("os.version"));

‎bugsnag/src/main/java/com/bugsnag/callbacks/JakartaServletCallback.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ public boolean onError(Report report) {
3535

3636
// Add request information to metadata
3737
report
38-
.addToTab("request", "url", request.getRequestURL().toString())
39-
.addToTab("request", "method", request.getMethod())
40-
.addToTab("request", "params",
38+
.addMetadata("request", "url", request.getRequestURL().toString())
39+
.addMetadata("request", "method", request.getMethod())
40+
.addMetadata("request", "params",
4141
new HashMap<String, String[]>(request.getParameterMap()))
42-
.addToTab("request", "clientIp", getClientIp(request))
43-
.addToTab("request", "headers", getHeaderMap(request));
42+
.addMetadata("request", "clientIp", getClientIp(request))
43+
.addMetadata("request", "headers", getHeaderMap(request));
4444

4545
// Set default context
4646
if (report.getContext() == null) {

‎bugsnag/src/test/java/com/bugsnag/AppenderMetadataTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public void testMetadataRemoval() {
109109

110110
// Send three test logs, the first one with report metadata added
111111
LOGGER.warn(new BugsnagMarker(report -> {
112-
report.addToTab("report", "some key", "some report value");
112+
report.addMetadata("report", "some key", "some report value");
113113
return true;
114114
}), "Test exception", new RuntimeException("test"));
115115

‎bugsnag/src/test/java/com/bugsnag/BugsnagTest.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -186,10 +186,10 @@ public void close() {
186186
}
187187
});
188188
assertTrue(bugsnag.notify(new Throwable(), report -> {
189-
report.addToTab("firsttab", "testredact1", "secretpassword");
190-
report.addToTab("firsttab", "testredact2", "secretpassword");
191-
report.addToTab("firsttab", "testredact3", "secretpassword");
192-
report.addToTab("secondtab", "testredact1", "secretpassword");
189+
report.addMetadata("firsttab", "testredact1", "secretpassword");
190+
report.addMetadata("firsttab", "testredact2", "secretpassword");
191+
report.addMetadata("firsttab", "testredact3", "secretpassword");
192+
report.addMetadata("secondtab", "testredact1", "secretpassword");
193193
return true;
194194
}));
195195
}
@@ -225,7 +225,7 @@ public void close() {
225225
headers.put("Cookie", "123456ABCDEF");
226226
headers.put("cookie", "123456ABCDEF");
227227

228-
report.addToTab("request", "headers", headers);
228+
report.addMetadata("request", "headers", headers);
229229
return true;
230230
}));
231231
}

‎examples/logback/src/main/java/com/bugsnag/example/logback/cli/Application.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ public static void main(String[] args) throws Exception {
2222
if (appender instanceof BugsnagAppender) {
2323
// Set some global meta data (added to each report)
2424
((BugsnagAppender) appender).getClient().addCallback((report) -> {
25-
report.addToTab("diagnostics", "timestamp", new Date());
26-
report.addToTab("customer", "name", "acme-inc");
27-
report.addToTab("customer", "paying", true);
28-
report.addToTab("customer", "spent", 1234);
25+
report.addMetadata("diagnostics", "timestamp", new Date());
26+
report.addMetadata("customer", "name", "acme-inc");
27+
report.addMetadata("customer", "paying", true);
28+
report.addMetadata("customer", "spent", 1234);
2929
report.setUserName("User Name");
3030
report.setUserEmail("user@example.com");
3131
report.setUserId("12345");
@@ -58,8 +58,8 @@ public static void main(String[] args) throws Exception {
5858
throw new RuntimeException("Handled exception - custom metadata");
5959
} catch (RuntimeException e) {
6060
LOGGER.warn(new BugsnagMarker((report) -> {
61-
report.addToTab("report tab", "data key 1", "data value 1");
62-
report.addToTab("report tab", "data key 2", "data value 2");
61+
report.addMetadata("report tab", "data key 1", "data value 1");
62+
report.addMetadata("report tab", "data key 2", "data value 2");
6363
return true;
6464
}), "Something bad happened", e);
6565
}

‎examples/simple/src/main/java/com/bugsnag/example/simple/ExampleApp.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ public static void main(String[] args) throws InterruptedException {
2323
bugsnag.addCallback(new Callback() {
2424
@Override
2525
public boolean onError(Report report) {
26-
report.addToTab("diagnostics", "timestamp", new Date());
27-
report.addToTab("customer", "name", "acme-inc");
28-
report.addToTab("customer", "paying", true);
29-
report.addToTab("customer", "spent", 1234);
26+
report.addMetadata("diagnostics", "timestamp", new Date());
27+
report.addMetadata("customer", "name", "acme-inc");
28+
report.addMetadata("customer", "paying", true);
29+
report.addMetadata("customer", "spent", 1234);
3030
report.setUserName("User Name");
3131
report.setUserEmail("user@example.com");
3232
report.setUserId("12345");
@@ -56,7 +56,7 @@ public boolean onError(Report report) {
5656
@Override
5757
public boolean onError(Report report) {
5858
report.setSeverity(Severity.WARNING);
59-
report.addToTab("report", "something", "that happened");
59+
report.addMetadata("report", "something", "that happened");
6060
report.setContext("the context");
6161
return true;
6262
}

‎examples/spring-web/src/main/java/com/bugsnag/example/spring/web/ApplicationRestController.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public String sendHandledExceptionWithMetadata() {
7373
@Override
7474
public boolean onError(Report report) {
7575
report.setSeverity(Severity.WARNING);
76-
report.addToTab("report", "something", "that happened");
76+
report.addMetadata("report", "something", "that happened");
7777
report.setContext("the context");
7878
return true;
7979
}

‎examples/spring-web/src/main/java/com/bugsnag/example/spring/web/Config.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ public Bugsnag bugsnag() {
3232
bugsnag.addCallback(new Callback() {
3333
@Override
3434
public boolean onError(Report report) {
35-
report.addToTab("diagnostics", "timestamp", new Date());
36-
report.addToTab("customer", "name", "acme-inc");
37-
report.addToTab("customer", "paying", true);
38-
report.addToTab("customer", "spent", 1234);
35+
report.addMetadata("diagnostics", "timestamp", new Date());
36+
report.addMetadata("customer", "name", "acme-inc");
37+
report.addMetadata("customer", "paying", true);
38+
report.addMetadata("customer", "spent", 1234);
3939
report.setUserName("User Name");
4040
report.setUserEmail("user@example.com");
4141
report.setUserId("12345");

0 commit comments

Comments
 (0)