Module: OpenTelemetry::SemConv::Incubating::FILE

Defined in:

lib/opentelemetry/semconv/incubating/file/attributes.rb

Attribute Names

FILE_ACCESSED =

Note:

Stability Level: development

Time when the file was last accessed, in ISO 8601 format.

This attribute might not be supported by some file systems — NFS, FAT32, in embedded OS, etc.

Examples:

Sample Values

2021-01-01T12:00:00Z

'file.accessed'

FILE_ATTRIBUTES =

Note:

Stability Level: development

Array of file attributes.

Attributes names depend on the OS or file system. Here’s a non-exhaustive list of values expected for this attribute: archive, compressed, directory, encrypted, execute, hidden, immutable, journaled, read, readonly, symbolic link, system, temporary, write.

Examples:

Sample Values

["readonly", "hidden"]

'file.attributes'

FILE_CHANGED =

Note:

Stability Level: development

Time when the file attributes or metadata was last changed, in ISO 8601 format.

file.changed captures the time when any of the file’s properties or attributes (including the content) are changed, while file.modified captures the timestamp when the file content is modified.

Examples:

Sample Values

2021-01-01T12:00:00Z

'file.changed'

FILE_CREATED =

Note:

Stability Level: development

Time when the file was created, in ISO 8601 format.

This attribute might not be supported by some file systems — NFS, FAT32, in embedded OS, etc.

Examples:

Sample Values

2021-01-01T12:00:00Z

'file.created'

FILE_DIRECTORY =

Note:

Stability Level: development

Directory where the file is located. It should include the drive letter, when appropriate.

Examples:

Sample Values

/home/user
C:\Program Files\MyApp

'file.directory'

FILE_EXTENSION =

Note:

Stability Level: development

File extension, excluding the leading dot.

When the file name has multiple extensions (example.tar.gz), only the last one should be captured (“gz”, not “tar.gz”).

Examples:

Sample Values

png
gz

'file.extension'

FILE_FORK_NAME =

Note:

Stability Level: development

Name of the fork. A fork is additional data associated with a filesystem object.

On Linux, a resource fork is used to store additional data with a filesystem object. A file always has at least one fork for the data portion, and additional forks may exist. On NTFS, this is analogous to an Alternate Data Stream (ADS), and the default data stream for a file is just called $DATA. Zone.Identifier is commonly used by Windows to track contents downloaded from the Internet. An ADS is typically of the form: C:\path\to\filename.extension:some_fork_name, and some_fork_name is the value that should populate fork_name. filename.extension should populate file.name, and extension should populate file.extension. The full path, file.path, will include the fork name.

Examples:

Sample Values

Zone.Identifer

'file.fork_name'

FILE_GROUP_ID =

Note:

Stability Level: development

Primary Group ID (GID) of the file.

Examples:

Sample Values

1000

'file.group.id'

FILE_GROUP_NAME =

Note:

Stability Level: development

Primary group name of the file.

Examples:

Sample Values

users

'file.group.name'

FILE_INODE =

Note:

Stability Level: development

Inode representing the file in the filesystem.

Examples:

Sample Values

256383

'file.inode'

FILE_MODE =

Note:

Stability Level: development

Mode of the file in octal representation.

Examples:

Sample Values

0640

'file.mode'

FILE_MODIFIED =

Note:

Stability Level: development

Time when the file content was last modified, in ISO 8601 format.

Examples:

Sample Values

2021-01-01T12:00:00Z

'file.modified'

FILE_NAME =

Note:

Stability Level: development

Name of the file including the extension, without the directory.

Examples:

Sample Values

example.png

'file.name'

FILE_OWNER_ID =

Note:

Stability Level: development

The user ID (UID) or security identifier (SID) of the file owner.

Examples:

Sample Values

1000

'file.owner.id'

FILE_OWNER_NAME =

Note:

Stability Level: development

Username of the file owner.

Examples:

Sample Values

root

'file.owner.name'

FILE_PATH =

Note:

Stability Level: development

Full path to the file, including the file name. It should include the drive letter, when appropriate.

Examples:

Sample Values

/home/alice/example.png
C:\Program Files\MyApp\myapp.exe

'file.path'

FILE_SIZE =

Note:

Stability Level: development

File size in bytes.

'file.size'

FILE_SYMBOLIC_LINK_TARGET_PATH =

Note:

Stability Level: development

Path to the target of a symbolic link.

This attribute is only applicable to symbolic links.

Examples:

Sample Values

/usr/bin/python3

'file.symbolic_link.target_path'