Stackify API for Java


License

License

Categories

Categories

Java Languages
GroupId

GroupId

com.stackify
ArtifactId

ArtifactId

stackify-api-java
Last Version

Last Version

4.0.2
Release Date

Release Date

Type

Type

jar
Description

Description

Stackify API for Java
Stackify API for Java
Project URL

Project URL

https://github.com/stackify/stackify-api-java
Project Organization

Project Organization

Stackify, LLC
Source Code Management

Source Code Management

https://github.com/stackify/stackify-api-java

Download stackify-api-java

How to add to project

<!-- https://jarcasting.com/artifacts/com.stackify/stackify-api-java/ -->
<dependency>
    <groupId>com.stackify</groupId>
    <artifactId>stackify-api-java</artifactId>
    <version>4.0.2</version>
</dependency>
// https://jarcasting.com/artifacts/com.stackify/stackify-api-java/
implementation 'com.stackify:stackify-api-java:4.0.2'
// https://jarcasting.com/artifacts/com.stackify/stackify-api-java/
implementation ("com.stackify:stackify-api-java:4.0.2")
'com.stackify:stackify-api-java:jar:4.0.2'
<dependency org="com.stackify" name="stackify-api-java" rev="4.0.2">
  <artifact name="stackify-api-java" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.stackify', module='stackify-api-java', version='4.0.2')
)
libraryDependencies += "com.stackify" % "stackify-api-java" % "4.0.2"
[com.stackify/stackify-api-java "4.0.2"]

Dependencies

compile (9)

Group / Artifact Type Version
org.slf4j : slf4j-api jar 1.7.28
com.fasterxml.jackson.core : jackson-core jar 2.9.9
com.fasterxml.jackson.core : jackson-annotations jar 2.9.9
com.fasterxml.jackson.core : jackson-databind jar 2.9.10.5
org.apache.httpcomponents : httpclient jar 4.5.9
com.kohlschutter.junixsocket : junixsocket-common jar 2.2.0
com.kohlschutter.junixsocket : junixsocket-native-common jar 2.2.0
net.jodah : failsafe jar 2.3.0
com.google.protobuf : protobuf-java jar 3.9.1

provided (1)

Group / Artifact Type Version
org.projectlombok : lombok jar 1.18.8

test (6)

Group / Artifact Type Version
org.slf4j : slf4j-log4j12 jar 1.7.28
junit : junit jar 4.11
org.mockito : mockito-core jar 1.9.5
org.powermock : powermock-core jar 1.5.6
org.powermock : powermock-module-junit4 jar 1.5.6
org.powermock : powermock-api-mockito jar 1.5.6

Project Modules

There are no modules declared in this project.

Maven Central Coverage Status

Stackify API for Java

Installation

Add it as a maven dependency:

<dependency>
    <groupId>com.stackify</groupId>
    <artifactId>stackify-api-java</artifactId>
    <version>4.0.2</version>
</dependency>

Configuration and Usage for Direct Logger

You need a stackify-api.properties file on your classpath that defines the configuration required for the Log API:

stackify.apiKey=YOUR_API_KEY
stackify.application=YOUR_APPLICATION_NAME
stackify.environment=YOUR_ENVIRONMENT

Masking

The Stackify logger has built-in data masking for credit cards and social security number values.

Enable Masking:

Add stackify.log.mask.enabled=true to stackify-api.properties.

Customize Masking:

The example below has the following customizations:

  1. Credit Card value masking is disabled (stackify.log.mask.CREDITCARD=false)
  2. IP Address masking is enabled (stackify.log.mask.IP=true). Built in masks are CREDITCARD, SSN and IP.
  3. Custom masking to remove vowels using a regex (stackify.log.mask.custom.VOWELS=[aeiou])
stackify.log.mask.enabled=true
stackify.log.mask.CREDITCARD=false
stackify.log.mask.SSN=true
stackify.log.mask.IP=true
stackify.log.mask.custom.VOWELS=[aeiou]

Note: If you are logging from a device that has the stackify-agent installed, the environment setting is optional. We will use the environment associated to your device in Stackify.

Log a message to Stackify

Logger.queueMessage("info", "Test message");

Log an exception to Stackify

Logger.queueException("error", e);

Log a message and exception to Stackify

Logger.queueException("error", "Test message", e);

Be sure to shutdown the Direct Logger to flush this appender of any messages and shutdown the background thread:

LogManager.shutdown();

Legacy Support

For legacy support of Java 1.6 and 1.7 use the following maven dependency:

<dependency>
    <groupId>com.stackify</groupId>
    <artifactId>stackify-api-java</artifactId>
    <version>3.1.2</version>
</dependency>

License

Copyright 2019 Stackify, LLC.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

com.stackify

Stackify

Stackify helps developers manage and troubleshoot application problems with integrated monitoring, metrics, errors & logs.

Versions

Version
4.0.2
4.0.1
4.0.0
3.1.2
3.1.1
3.1.0
3.0.9
3.0.8
3.0.7
3.0.6
3.0.5
3.0.4
3.0.3
2.1.8
2.1.7
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0