Static Analysis Results Format (SARIF), Version 2.1.0-rtm.2 Json Format

Use this form to visualize Static Analysis Results Format (SARIF), Version 2.1.0-rtm.2.

$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.

#	language	baselineGuid	defaultEncoding	defaultSourceLanguage	columnKind	Actions
{{$index+1}}.	{{row.language}}	{{row.baselineGuid}}	{{row.defaultEncoding}}	{{row.defaultSourceLanguage}}	{{row.columnKind}}

inlineExternalProperties References to external property files that share data between runs.

#	schema	version	guid	runGuid	Actions
{{$index+1}}.	{{row.schema}}	{{row.version}}	{{row.guid}}	{{row.runGuid}}

language - The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

invocations Describes the invocation of the analysis tool.

#	commandLine	startTimeUtc	endTimeUtc	exitCode	exitCodeDescription	exitSignalName	exitSignalNumber	processStartFailureMessage	executionSuccessful	machine	Actions
{{$index+1}}.	{{row.commandLine}}	{{row.startTimeUtc}}	{{row.endTimeUtc}}	{{row.exitCode}}	{{row.exitCodeDescription}}	{{row.exitSignalName}}	{{row.exitSignalNumber}}	{{row.processStartFailureMessage}}	{{row.executionSuccessfulSelected.DisplayText}}	{{row.machine}}

versionControlProvenance Specifies the revision in version control of the artifacts that were scanned.

#	repositoryUri	revisionId	branch	revisionTag	asOfTimeUtc	Actions
{{$index+1}}.

.originalUriBaseIds

_runs

baselineGuid - The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.

defaultEncoding - Specifies the default encoding for any artifact object that refers to a text file.

defaultSourceLanguage - Specifies the default source language for any artifact object that refers to a text file that contains source code.

columnKind - Specifies the unit in which the tool measures columns.

artifacts An array of artifact objects relevant to the run.

#	parentIndex	offset	length	mimeType	encoding	sourceLanguage	lastModifiedTimeUtc	Actions
{{$index+1}}.	{{row.parentIndex}}	{{row.offset}}	{{row.length}}	{{row.mimeType}}	{{row.encoding}}	{{row.sourceLanguage}}	{{row.lastModifiedTimeUtc}}

logicalLocations An array of logical locations such as namespaces, types or functions.

#	name	index	fullyQualifiedName	decoratedName	parentIndex	kind	Actions
{{$index+1}}.	{{row.name}}	{{row.index}}	{{row.fullyQualifiedName}}	{{row.decoratedName}}	{{row.parentIndex}}	{{row.kind}}

graphs An array of zero or more unique graph objects associated with the run.

#	Actions
{{$index+1}}.

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) if a log file represents an actual scan.

#	ruleId	ruleIndex	kind	level	guid	correlationGuid	occurrenceCount	baselineState	rank	hostedViewerUri	Actions
{{$index+1}}.	{{row.ruleId}}	{{row.ruleIndex}}	{{row.kind}}	{{row.level}}	{{row.guid}}	{{row.correlationGuid}}	{{row.occurrenceCount}}	{{row.baselineState}}	{{row.rank}}	{{row.hostedViewerUri}}

runAggregates Automation details that describe the aggregate of runs to which this run belongs.

#	id	guid	correlationGuid	Actions
{{$index+1}}.

redactionTokens An array of strings used to replace sensitive information in a redaction-aware property.

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

newlineSequences An ordered list of character sequences that were treated as line breaks when computing region information for the run.

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

threadFlowLocations An array of threadFlowLocation objects cached at run level.

#	index	module	nestingLevel	executionOrder	executionTimeUtc	importance	Actions
{{$index+1}}.	{{row.index}}	{{row.module}}	{{row.nestingLevel}}	{{row.executionOrder}}	{{row.executionTimeUtc}}	{{row.importance}}

taxonomies An array of toolComponent objects relevant to a taxonomy in which results are categorized.

#	guid	name	organization	product	productSuite	fullName	version	semanticVersion	dottedQuadFileVersion	releaseDateUtc	Actions
{{$index+1}}.	{{row.guid}}	{{row.name}}	{{row.organization}}	{{row.product}}	{{row.productSuite}}	{{row.fullName}}	{{row.version}}	{{row.semanticVersion}}	{{row.dottedQuadFileVersion}}	{{row.releaseDateUtc}}

addresses Addresses associated with this run instance, if any.

#	absoluteAddress	relativeAddress	length	kind	name	fullyQualifiedName	offsetFromParent	index	parentIndex	Actions
{{$index+1}}.	{{row.absoluteAddress}}	{{row.relativeAddress}}	{{row.length}}	{{row.kind}}	{{row.name}}	{{row.fullyQualifiedName}}	{{row.offsetFromParent}}	{{row.index}}	{{row.parentIndex}}

translations The set of available translations of the localized data provided by the tool.

#	guid	name	organization	product	productSuite	fullName	version	semanticVersion	dottedQuadFileVersion	releaseDateUtc	Actions
{{$index+1}}.	{{row.guid}}	{{row.name}}	{{row.organization}}	{{row.product}}	{{row.productSuite}}	{{row.fullName}}	{{row.version}}	{{row.semanticVersion}}	{{row.dottedQuadFileVersion}}	{{row.releaseDateUtc}}

policies Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).

#	guid	name	organization	product	productSuite	fullName	version	semanticVersion	dottedQuadFileVersion	releaseDateUtc	Actions
{{$index+1}}.	{{row.guid}}	{{row.name}}	{{row.organization}}	{{row.product}}	{{row.productSuite}}	{{row.fullName}}	{{row.version}}	{{row.semanticVersion}}	{{row.dottedQuadFileVersion}}	{{row.releaseDateUtc}}

webRequests An array of request objects cached at run level.

#	index	protocol	version	target	method	Actions
{{$index+1}}.

webResponses An array of response objects cached at run level.

#	index	protocol	version	statusCode	reasonPhrase	noResponseReceived	Actions
{{$index+1}}.	{{row.index}}	{{row.protocol}}	{{row.version}}	{{row.statusCode}}	{{row.reasonPhrase}}	{{row.noResponseReceivedSelected.DisplayText}}

commandLine - The command line used to invoke the tool.

startTimeUtc - The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

endTimeUtc - The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

exitCode - The process exit code.

exitCodeDescription - The reason for the process exit.

exitSignalName - The name of the signal that caused the process to exit.

exitSignalNumber - The numeric value of the signal that caused the process to exit.

processStartFailureMessage - The reason given by the operating system that the process failed to start.

executionSuccessful - Specifies whether the tool's execution completed successfully.

machine - The machine that hosted the analysis tool run.

account - The account that ran the analysis tool.

processId - The process id for the analysis tool run.

arguments An array of strings, containing in order the command line arguments passed to the tool from the operating system.

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

responseFiles The locations of any response files specified on the tool's command line.

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

ruleConfigurationOverrides An array of configurationOverride objects that describe rules related runtime overrides.

#	Actions
{{$index+1}}.

notificationConfigurationOverrides An array of configurationOverride objects that describe notifications related runtime overrides.

#	Actions
{{$index+1}}.

toolExecutionNotifications A list of runtime conditions detected by the tool during the analysis.

#	level	threadId	timeUtc	Actions
{{$index+1}}.	{{row.level}}	{{row.threadId}}	{{row.timeUtc}}

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

#	level	threadId	timeUtc	Actions
{{$index+1}}.	{{row.level}}	{{row.threadId}}	{{row.timeUtc}}

.environmentVariables

_invocations

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

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

timeUtc - The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.

locations The locations relevant to this notification.

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

id - Value that distinguishes this location from all other locations within a single result object.

logicalLocations The logical locations associated with the result.

#	name	index	fullyQualifiedName	decoratedName	parentIndex	kind	Actions
{{$index+1}}.	{{row.name}}	{{row.index}}	{{row.fullyQualifiedName}}	{{row.decoratedName}}	{{row.parentIndex}}	{{row.kind}}

annotations A set of regions relevant to the location.

#	startLine	startColumn	endLine	endColumn	charOffset	charLength	byteOffset	byteLength	sourceLanguage	Actions
{{$index+1}}.	{{row.startLine}}	{{row.startColumn}}	{{row.endLine}}	{{row.endColumn}}	{{row.charOffset}}	{{row.charLength}}	{{row.byteOffset}}	{{row.byteLength}}	{{row.sourceLanguage}}

relationships An array of objects that describe relationships between this location and others.

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

target - A reference to the related location.

kinds A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.

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

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

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

timeUtc - The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.

locations The locations relevant to this notification.

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

parentIndex - Identifies the index of the immediate parent of the artifact, if this artifact is nested.

offset - The offset in bytes of the artifact within its containing artifact.

length - The length of the artifact in bytes.

mimeType - The MIME type (RFC 2045) of the artifact.

encoding - Specifies the encoding for an artifact object that refers to a text file.

sourceLanguage - Specifies the source language for any artifact object that refers to a text file that contains source code.

roles The role or roles played by the artifact in the analysis.

#	Actions
{{$index+1}}.

.hashes

_artifacts

lastModifiedTimeUtc - The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.

nodes An array of node objects representing the nodes of the graph.

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

edges An array of edge objects representing the edges of the graph.

#	id	sourceNodeId	targetNodeId	Actions
{{$index+1}}.

id - A string that uniquely identifies the node within its graph.

children Array of child nodes.

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

id - A string that uniquely identifies the node within its graph.

children Array of child nodes.

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

ruleId - The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.

ruleIndex - The index within the tool component rules array of the rule object associated with this result.

kind - A value that categorizes results by evaluation state.

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

guid - A stable, unique identifier for the result in the form of a GUID.

correlationGuid - A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.

occurrenceCount - A positive integer specifying the number of times this logically unique result was observed in this run.

locations The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

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

.partialFingerprints

_results

.fingerprints

_results

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

rank - A number representing the priority or importance of the result.

hostedViewerUri - An absolute URI at which the result can be viewed.

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

#	Actions
{{$index+1}}.

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

#	Actions
{{$index+1}}.

graphs An array of zero or more unique graph objects associated with the result.

#	Actions
{{$index+1}}.

graphTraversals An array of one or more unique 'graphTraversal' objects.

#	runGraphIndex	resultGraphIndex	Actions
{{$index+1}}.	{{row.runGraphIndex}}	{{row.resultGraphIndex}}

relatedLocations A set of locations relevant to this result.

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

suppressions A set of suppressions relevant to this result.

#	guid	kind	state	justification	Actions
{{$index+1}}.

attachments A set of artifacts relevant to the result.

#	Actions
{{$index+1}}.

workItemUris The URIs of the work items associated with this result.

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

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

#	Actions
{{$index+1}}.

taxa An array of references to taxonomy reporting descriptors that are applicable to the result.

#	id	index	guid	Actions
{{$index+1}}.

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

#	module	threadId	Actions
{{$index+1}}.	{{row.module}}	{{row.threadId}}

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

threadId - The thread identifier of the stack frame.

parameters The parameters of the call that is executing.

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

threadFlows An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.

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

id - An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.

.initialState

_threadFlows

.immutableState

_threadFlows

locations A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.

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

runGraphIndex - The index within the run.graphs to be associated with the result.

resultGraphIndex - The index within the result.graphs to be associated with the result.

.initialState

_graphTraversals

.immutableState

_graphTraversals

edgeTraversals The sequences of edges traversed by this graph traversal.

#	edgeId	stepOverEdgeCount	Actions
{{$index+1}}.

.finalState

_edgeTraversals

id - Value that distinguishes this location from all other locations within a single result object.

logicalLocations The logical locations associated with the result.

#	name	index	fullyQualifiedName	decoratedName	parentIndex	kind	Actions
{{$index+1}}.	{{row.name}}	{{row.index}}	{{row.fullyQualifiedName}}	{{row.decoratedName}}	{{row.parentIndex}}	{{row.kind}}

annotations A set of regions relevant to the location.

#	startLine	startColumn	endLine	endColumn	charOffset	charLength	byteOffset	byteLength	sourceLanguage	Actions
{{$index+1}}.	{{row.startLine}}	{{row.startColumn}}	{{row.endLine}}	{{row.endColumn}}	{{row.charOffset}}	{{row.charLength}}	{{row.byteOffset}}	{{row.byteLength}}	{{row.sourceLanguage}}

relationships An array of objects that describe relationships between this location and others.

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

regions An array of regions of interest within the attachment.

#	startLine	startColumn	endLine	endColumn	charOffset	charLength	byteOffset	byteLength	sourceLanguage	Actions
{{$index+1}}.	{{row.startLine}}	{{row.startColumn}}	{{row.endLine}}	{{row.endColumn}}	{{row.charOffset}}	{{row.charLength}}	{{row.byteOffset}}	{{row.byteLength}}	{{row.sourceLanguage}}

rectangles An array of rectangles specifying areas of interest within the image.

#	top	left	bottom	right	Actions
{{$index+1}}.

artifactChanges One or more artifact changes that comprise a fix for a result.

#	Actions
{{$index+1}}.

replacements An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.

#	Actions
{{$index+1}}.

index - The index within the run threadFlowLocations array.

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

kinds A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.

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

taxa An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.

#	id	index	guid	Actions
{{$index+1}}.

.state

_threadFlowLocations

nestingLevel - An integer representing a containment hierarchy within the thread flow.

executionOrder - An integer representing the temporal order in which execution reached this location.

executionTimeUtc - The Coordinated Universal Time (UTC) date and time at which this location was executed.

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".

guid - A unique identifier for the tool component in the form of a GUID.

name - The name of the tool component.

organization - The organization or company that produced the tool component.

product - A product suite to which the tool component belongs.

productSuite - A localizable string containing the name of the suite of products to which the tool component belongs.

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

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

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

dottedQuadFileVersion - The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

releaseDateUtc - A string specifying the UTC date (and optionally, the time) of the component's release.

downloadUri - The absolute URI from which the tool component can be downloaded.

informationUri - The absolute URI at which information about this version of the tool component can be found.

.globalMessageStrings

_taxonomies

language - The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

isComprehensive - Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

localizedDataSemanticVersion - The semantic version of the localized strings defined in this component; maintained by components that provide translations.

minimumRequiredLocalizedDataSemanticVersion - The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

notifications An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

#	id	guid	name	helpUri	Actions
{{$index+1}}.	{{row.id}}	{{row.guid}}	{{row.name}}	{{row.helpUri}}

rules An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

#	id	guid	name	helpUri	Actions
{{$index+1}}.	{{row.id}}	{{row.guid}}	{{row.name}}	{{row.helpUri}}

taxa An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

#	id	index	guid	Actions
{{$index+1}}.

locations An array of the artifactLocation objects associated with the tool component.

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

contents The kinds of data contained in this object.

#	Actions
{{$index+1}}.

supportedTaxonomies An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

#	name	index	guid	Actions
{{$index+1}}.

id - A stable, opaque identifier for the report.

guid - A unique identifier for the reporting descriptor in the form of a GUID.

name - A report identifier that is understandable to an end user.

deprecatedIds An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.

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

deprecatedGuids An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.

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

deprecatedNames An array of readable identifiers by which this report was known in some previous version of the analysis tool.

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

.messageStrings

_notifications

helpUri - A URI where the primary documentation for the report can be found.

relationships An array of objects that describe relationships between this reporting descriptor and others.

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