Static Analysis Results Interchange Format (SARIF) version 1 Json Format

Use this form to visualize Static Analysis Results Interchange Format (SARIF) version 1.

$schema - The URI of the JSON schema corresponding to the version.

version - The SARIF format version of this log file.

runs The set of runs contained in this log file.

#	tool.name	tool.fullName	tool.version	tool.semanticVersion	tool.fileVersion	tool.sarifLoggerVersion	tool.language	invocation.commandLine	invocation.startTime	invocation.endTime	Actions
{{$index+1}}.	{{row.tool.name}}	{{row.tool.fullName}}	{{row.tool.version}}	{{row.tool.semanticVersion}}	{{row.tool.fileVersion}}	{{row.tool.sarifLoggerVersion}}	{{row.tool.language}}	{{row.invocation.commandLine}}	{{row.invocation.startTime}}	{{row.invocation.endTime}}

.tool

_runs

tool.name - The name of the tool.

tool.fullName - The name of the tool along with its version and any other useful identifying information, such as its locale.

tool.version - The tool version, in whatever format the tool natively provides.

tool.semanticVersion - The tool version in the format specified by Semantic Versioning 2.0.

tool.fileVersion - The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).

tool.sarifLoggerVersion - A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.

tool.language - The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).

.tool.properties

_runs

tool.properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

.invocation

_runs

invocation.commandLine - The command line used to invoke the tool.

.invocation.responseFiles

_runs

invocation.startTime - The date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

invocation.endTime - The date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

invocation.machine - The machine that hosted the analysis tool run.

invocation.account - The account that ran the analysis tool.

invocation.processId - The process id for the analysis tool run.

invocation.fileName - The fully qualified path to the analysis tool.

invocation.workingDirectory - The working directory for the analysis rool run.

.invocation.environmentVariables

_runs

.invocation.properties

_runs

invocation.properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

.files

_runs

.logicalLocations

_runs

results The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) in the event that a log file represents an actual scan.

#	ruleId	ruleKey	level	message	formattedRuleMessage.formatId	snippet	id	toolFingerprintContribution	baselineState	Actions
{{$index+1}}.	{{row.ruleId}}	{{row.ruleKey}}	{{row.level}}	{{row.message}}	{{row.formattedRuleMessage.formatId}}	{{row.snippet}}	{{row.id}}	{{row.toolFingerprintContribution}}	{{row.baselineState}}

toolNotifications A list of runtime conditions detected by the tool in the course of the analysis.

#	id	ruleId	ruleKey	physicalLocation.uri	physicalLocation.uriBaseId	physicalLocation.region.startLine	physicalLocation.region.startColumn	physicalLocation.region.endLine	physicalLocation.region.endColumn	physicalLocation.region.offset	Actions
{{$index+1}}.	{{row.id}}	{{row.ruleId}}	{{row.ruleKey}}	{{row.physicalLocation.uri}}	{{row.physicalLocation.uriBaseId}}	{{row.physicalLocation.region.startLine}}	{{row.physicalLocation.region.startColumn}}	{{row.physicalLocation.region.endLine}}	{{row.physicalLocation.region.endColumn}}	{{row.physicalLocation.region.offset}}

configurationNotifications A list of conditions detected by the tool that are relevant to the tool's configuration.

#	id	ruleId	ruleKey	physicalLocation.uri	physicalLocation.uriBaseId	physicalLocation.region.startLine	physicalLocation.region.startColumn	physicalLocation.region.endLine	physicalLocation.region.endColumn	physicalLocation.region.offset	Actions
{{$index+1}}.	{{row.id}}	{{row.ruleId}}	{{row.ruleKey}}	{{row.physicalLocation.uri}}	{{row.physicalLocation.uriBaseId}}	{{row.physicalLocation.region.startLine}}	{{row.physicalLocation.region.startColumn}}	{{row.physicalLocation.region.endLine}}	{{row.physicalLocation.region.endColumn}}	{{row.physicalLocation.region.offset}}

.rules

_runs

id - An identifier for the run.

stableId - A stable identifier for a run, for example, 'nightly Clang analyzer run'. Multiple runs of the same type can have the same stableId.

automationId - A global identifier that allows the run to be correlated with other artifacts produced by a larger automation process.

baselineId - The 'id' property of a separate (potentially external) SARIF 'run' instance that comprises the baseline that was used to compute result 'baselineState' properties for the run.

architecture - The hardware architecture for which the run was targeted.

ruleId - The stable, unique identifier of the rule (if any) to which this notification is relevant. If 'ruleKey' is not specified, this member can be used to retrieve rule metadata from the rules dictionary, if it exists.

ruleKey - A key used to retrieve the rule metadata from the rules dictionary that is relevant to the notification.

level - A value specifying the severity level of the result. If this property is not present, its implied value is 'warning'.

message - A string that describes the result. The first sentence of the message only will be displayed when visible space is limited.

.formattedRuleMessage

_results

formattedRuleMessage.formatId - A string that identifies the message format used to format the message that describes this result. The value of formatId must correspond to one of the names in the set of name/value pairs contained in the 'messageFormats' property of the rule object whose 'id' property matches the 'ruleId' property of this result.

snippet - A source code or other file fragment that illustrates the result.

id - A unique identifier for the result.

toolFingerprintContribution - A string that contributes to the unique identity of the result.

baselineState - The state of a result relative to a baseline of a previous run.

formattedRuleMessage.arguments An array of strings that will be used, in combination with a message format, to construct a result message.

#	Values	Actions
{{$index+1}}.

locations One or more locations where the result occurred. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

#	analysisTarget.uri	analysisTarget.uriBaseId	analysisTarget.region.startLine	analysisTarget.region.startColumn	analysisTarget.region.endLine	analysisTarget.region.endColumn	analysisTarget.region.offset	analysisTarget.region.length	resultFile.uri	resultFile.uriBaseId	Actions
{{$index+1}}.	{{row.analysisTarget.uri}}	{{row.analysisTarget.uriBaseId}}	{{row.analysisTarget.region.startLine}}	{{row.analysisTarget.region.startColumn}}	{{row.analysisTarget.region.endLine}}	{{row.analysisTarget.region.endColumn}}	{{row.analysisTarget.region.offset}}	{{row.analysisTarget.region.length}}	{{row.resultFile.uri}}	{{row.resultFile.uriBaseId}}

stacks An array of 'stack' objects relevant to the result.

#	message	Actions
{{$index+1}}.	{{row.message}}

codeFlows An array of 'codeFlow' objects relevant to the result.

#	message	Actions
{{$index+1}}.	{{row.message}}

relatedLocations A grouped set of locations and messages, if available, that represent code areas that are related to this result.

#	id	step	physicalLocation.uri	physicalLocation.uriBaseId	physicalLocation.region.startLine	physicalLocation.region.startColumn	physicalLocation.region.endLine	physicalLocation.region.endColumn	physicalLocation.region.offset	physicalLocation.region.length	Actions
{{$index+1}}.	{{row.id}}	{{row.step}}	{{row.physicalLocation.uri}}	{{row.physicalLocation.uriBaseId}}	{{row.physicalLocation.region.startLine}}	{{row.physicalLocation.region.startColumn}}	{{row.physicalLocation.region.endLine}}	{{row.physicalLocation.region.endColumn}}	{{row.physicalLocation.region.offset}}	{{row.physicalLocation.region.length}}

suppressionStates suppressionStates

#	Actions
{{$index+1}}.

fixes An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.

#	description	Actions
{{$index+1}}.	{{row.description}}

.properties

_results

properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

.analysisTarget

_locations

analysisTarget.uri - The location of the file as a valid URI.

analysisTarget.uriBaseId - A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.

.analysisTarget.region

_locations

analysisTarget.region.startLine - The line number of the first character in the region.

analysisTarget.region.startColumn - The column number of the first character in the region.

analysisTarget.region.endLine - The line number of the last character in the region.

analysisTarget.region.endColumn - The column number of the last character in the region.

analysisTarget.region.offset - The zero-based offset from the beginning of the file of the first byte or character in the region.

analysisTarget.region.length - The length of the region in bytes or characters.

.resultFile

_locations

resultFile.uri - The location of the file as a valid URI.

resultFile.uriBaseId - A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.

.resultFile.region

_locations

resultFile.region.startLine - The line number of the first character in the region.

resultFile.region.startColumn - The column number of the first character in the region.

resultFile.region.endLine - The line number of the last character in the region.

resultFile.region.endColumn - The column number of the last character in the region.

resultFile.region.offset - The zero-based offset from the beginning of the file of the first byte or character in the region.

resultFile.region.length - The length of the region in bytes or characters.

fullyQualifiedLogicalName - The human-readable fully qualified name of the logical location where the analysis tool produced the result. If 'logicalLocationKey' is not specified, this member is can used to retrieve the location logicalLocation from the logicalLocations dictionary, if one exists.

logicalLocationKey - A key used to retrieve the location logicalLocation from the logicalLocations dictionary, when the string specified by 'fullyQualifiedLogicalName' is not unique.

decoratedName - The machine-readable fully qualified name for the logical location where the analysis tool produced the result, such as the mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.

.properties

_locations

properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

message - A message relevant to this call stack.

frames An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

#	message	uri	uriBaseId	line	column	module	threadId	fullyQualifiedLogicalName	logicalLocationKey	address	Actions
{{$index+1}}.	{{row.message}}	{{row.uri}}	{{row.uriBaseId}}	{{row.line}}	{{row.column}}	{{row.module}}	{{row.threadId}}	{{row.fullyQualifiedLogicalName}}	{{row.logicalLocationKey}}	{{row.address}}

.properties

_stacks

properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

message - A message relevant to this stack frame.

uri - The uri of the source code file to which this stack frame refers.

uriBaseId - A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.

line - The line of the location to which this stack frame refers.

column - The line of the location to which this stack frame refers.

module - The name of the module that contains the code of this stack frame.

threadId - The thread identifier of the stack frame.

fullyQualifiedLogicalName - The fully qualified name of the method or function that is executing.

logicalLocationKey - A key used to retrieve the stack frame logicalLocation from the logicalLocations dictionary, when the 'fullyQualifiedLogicalName' is not unique.

address - The address of the method or function that is executing.

offset - The offset from the method or function that is executing.

parameters The parameters of the call that is executing.

#	Values	Actions
{{$index+1}}.

.properties

_frames

properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

message - A message relevant to the code flow

locations An array of 'annotatedCodeLocation' objects, each of which describes a single location visited by the tool in the course of producing the result.

#	analysisTarget.uri	analysisTarget.uriBaseId	analysisTarget.region.startLine	analysisTarget.region.startColumn	analysisTarget.region.endLine	analysisTarget.region.endColumn	analysisTarget.region.offset	analysisTarget.region.length	resultFile.uri	resultFile.uriBaseId	Actions
{{$index+1}}.	{{row.analysisTarget.uri}}	{{row.analysisTarget.uriBaseId}}	{{row.analysisTarget.region.startLine}}	{{row.analysisTarget.region.startColumn}}	{{row.analysisTarget.region.endLine}}	{{row.analysisTarget.region.endColumn}}	{{row.analysisTarget.region.offset}}	{{row.analysisTarget.region.length}}	{{row.resultFile.uri}}	{{row.resultFile.uriBaseId}}

.properties

_codeFlows

properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

id - OBSOLETE (use "step" instead): An identifier for the location, unique within the scope of the code flow within which it occurs.

step - The 0-based sequence number of the location in the code flow within which it occurs.

.physicalLocation

_relatedLocations

physicalLocation.uri - The location of the file as a valid URI.

physicalLocation.uriBaseId - A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.

.physicalLocation.region

_relatedLocations

physicalLocation.region.startLine - The line number of the first character in the region.

physicalLocation.region.startColumn - The column number of the first character in the region.

physicalLocation.region.endLine - The line number of the last character in the region.

physicalLocation.region.endColumn - The column number of the last character in the region.

physicalLocation.region.offset - The zero-based offset from the beginning of the file of the first byte or character in the region.

physicalLocation.region.length - The length of the region in bytes or characters.

fullyQualifiedLogicalName - The fully qualified name of the method or function that is executing.

logicalLocationKey - A key used to retrieve the annotation's logicalLocation from the logicalLocations dictionary.

module - The name of the module that contains the code that is executing.

threadId - The thread identifier of the code that is executing.

message - A message relevant to this annotation.

kind - Categorizes the location.

taintKind - Classifies state transitions in code locations relevant to a taint analysis.

target - The fully qualified name of the target on which this location operates. For an annotation of kind 'call', for example, the target refers to the fully qualified logical name of the function called from this location.

values An ordered set of strings that comprise input or return values for the current operation. For an annotation of kind 'call', for example, this property may hold the ordered list of arguments passed to the callee.

#	Values	Actions
{{$index+1}}.

.state

_relatedLocations

targetKey - A key used to retrieve the target's logicalLocation from the logicalLocations dictionary.

essential - OBSOLETE (use "importance" instead): True if this location is essential to understanding the code flow in which it occurs.

importance - Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".

snippet - The source code at the specified location.

annotations A set of messages relevant to the current annotated code location.

#	message	Actions
{{$index+1}}.	{{row.message}}

.properties

_relatedLocations

properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

message - A message relevant to a code location

locations An array of 'physicalLocation' objects associated with the annotation.

#	analysisTarget.uri	analysisTarget.uriBaseId	analysisTarget.region.startLine	analysisTarget.region.startColumn	analysisTarget.region.endLine	analysisTarget.region.endColumn	analysisTarget.region.offset	analysisTarget.region.length	resultFile.uri	resultFile.uriBaseId	Actions
{{$index+1}}.	{{row.analysisTarget.uri}}	{{row.analysisTarget.uriBaseId}}	{{row.analysisTarget.region.startLine}}	{{row.analysisTarget.region.startColumn}}	{{row.analysisTarget.region.endLine}}	{{row.analysisTarget.region.endColumn}}	{{row.analysisTarget.region.offset}}	{{row.analysisTarget.region.length}}	{{row.resultFile.uri}}	{{row.resultFile.uriBaseId}}

description - A string that describes the proposed fix, enabling viewers to present a proposed change to an end user.

fileChanges One or more file changes that comprise a fix for a result.

#	uri	uriBaseId	Actions
{{$index+1}}.	{{row.uri}}	{{row.uriBaseId}}

uri - A string that represents the location of the file to change as a valid URI.

uriBaseId - A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.

replacements An array of replacement objects, each of which represents the replacement of a single range of bytes in a single file specified by 'uri'.

#	offset	deletedLength	insertedBytes	Actions
{{$index+1}}.

id - An identifier for the condition that was encountered.

ruleKey - A key used to retrieve the rule metadata from the rules dictionary that is relevant to the notification.

.physicalLocation

_toolNotifications

physicalLocation.uri - The location of the file as a valid URI.

physicalLocation.uriBaseId - A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.

.physicalLocation.region

_toolNotifications

physicalLocation.region.startLine - The line number of the first character in the region.

physicalLocation.region.startColumn - The column number of the first character in the region.

physicalLocation.region.endLine - The line number of the last character in the region.

physicalLocation.region.endColumn - The column number of the last character in the region.

physicalLocation.region.offset - The zero-based offset from the beginning of the file of the first byte or character in the region.

physicalLocation.region.length - The length of the region in bytes or characters.

message - A string that describes the condition that was encountered.

level - A value specifying the severity level of the notification.

threadId - The thread identifier of the code that generated the notification.

time - The date and time at which the analysis tool generated the notification.

.exception

_toolNotifications

exception.kind - A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

exception.message - A string that describes the exception.

.exception.stack

_toolNotifications

exception.stack.message - A message relevant to this call stack.

exception.stack.frames An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

#	message	uri	uriBaseId	line	column	module	threadId	fullyQualifiedLogicalName	logicalLocationKey	address	Actions
{{$index+1}}.	{{row.message}}	{{row.uri}}	{{row.uriBaseId}}	{{row.line}}	{{row.column}}	{{row.module}}	{{row.threadId}}	{{row.fullyQualifiedLogicalName}}	{{row.logicalLocationKey}}	{{row.address}}

.exception.stack.properties

_toolNotifications

exception.stack.properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

exception.innerExceptions An array of exception objects each of which is considered a cause of this exception.

#	kind	message	stack.message	Actions
{{$index+1}}.	{{row.kind}}	{{row.message}}	{{row.stack.message}}

.properties

_toolNotifications

properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

message - A message relevant to this stack frame.

uri - The uri of the source code file to which this stack frame refers.

uriBaseId - A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.

line - The line of the location to which this stack frame refers.

column - The line of the location to which this stack frame refers.

module - The name of the module that contains the code of this stack frame.

threadId - The thread identifier of the stack frame.

fullyQualifiedLogicalName - The fully qualified name of the method or function that is executing.

logicalLocationKey - A key used to retrieve the stack frame logicalLocation from the logicalLocations dictionary, when the 'fullyQualifiedLogicalName' is not unique.

address - The address of the method or function that is executing.

offset - The offset from the method or function that is executing.

parameters The parameters of the call that is executing.

#	Values	Actions
{{$index+1}}.

.properties

_exception_stack_frames

properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

kind - A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

message - A string that describes the exception.

.stack

_exception_innerExceptions

stack.message - A message relevant to this call stack.

stack.frames An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

#	message	uri	uriBaseId	line	column	module	threadId	fullyQualifiedLogicalName	logicalLocationKey	address	Actions
{{$index+1}}.	{{row.message}}	{{row.uri}}	{{row.uriBaseId}}	{{row.line}}	{{row.column}}	{{row.module}}	{{row.threadId}}	{{row.fullyQualifiedLogicalName}}	{{row.logicalLocationKey}}	{{row.address}}

.stack.properties

_exception_innerExceptions

stack.properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

innerExceptions An array of exception objects each of which is considered a cause of this exception.

#	kind	message	stack.message	Actions
{{$index+1}}.	{{row.kind}}	{{row.message}}	{{row.stack.message}}

message - A message relevant to this stack frame.

uri - The uri of the source code file to which this stack frame refers.

uriBaseId - A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.

line - The line of the location to which this stack frame refers.

column - The line of the location to which this stack frame refers.

module - The name of the module that contains the code of this stack frame.

threadId - The thread identifier of the stack frame.

fullyQualifiedLogicalName - The fully qualified name of the method or function that is executing.

logicalLocationKey - A key used to retrieve the stack frame logicalLocation from the logicalLocations dictionary, when the 'fullyQualifiedLogicalName' is not unique.

address - The address of the method or function that is executing.

offset - The offset from the method or function that is executing.

parameters The parameters of the call that is executing.

#	Values	Actions
{{$index+1}}.

.properties

_stack_frames

properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

kind - A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

message - A string that describes the exception.

.stack

_innerExceptions

stack.message - A message relevant to this call stack.

stack.frames An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

#	message	uri	uriBaseId	line	column	module	threadId	fullyQualifiedLogicalName	logicalLocationKey	address	Actions
{{$index+1}}.	{{row.message}}	{{row.uri}}	{{row.uriBaseId}}	{{row.line}}	{{row.column}}	{{row.module}}	{{row.threadId}}	{{row.fullyQualifiedLogicalName}}	{{row.logicalLocationKey}}	{{row.address}}

.stack.properties

_innerExceptions

stack.properties.tags A set of distinct strings that provide additional information.

#	Values	Actions
{{$index+1}}.

innerExceptions An array of exception objects each of which is considered a cause of this exception.

#	kind	message	stack.message	Actions
{{$index+1}}.	{{row.kind}}	{{row.message}}	{{row.stack.message}}

id - An identifier for the condition that was encountered.

ruleKey - A key used to retrieve the rule metadata from the rules dictionary that is relevant to the notification.

.physicalLocation

_configurationNotifications